Skip to content

Commit 634e247

Browse files
committed
improvements
1 parent 26b82c3 commit 634e247

1 file changed

Lines changed: 14 additions & 25 deletions

File tree

README.rst

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,10 @@ Key Features
6262
- ✅ **Validated algorithms** - Follows Wiscombe's trusted implementation
6363
- ✅ **Comprehensive outputs** - Extinction, scattering, backscattering, asymmetry
6464
- ✅ **Angular distributions** - Full scattering phase functions
65-
- ✅ **Field calculations** - Internal field coefficients (v3.0+)
6665
- ✅ **Flexible normalization** - Multiple conventions supported
6766
- ✅ **Code Jitting** - the python Numba package enables 10-50X speedup
67+
- ✅ **Field calculations** - Internal field coefficients coming!
6868

69-
Quick Start
70-
-----------
7169

7270
Installation
7371
~~~~~~~~~~~~
@@ -113,18 +111,18 @@ Basic Example
113111
API Reference
114112
-------------
115113

116-
Core Functions
117-
~~~~~~~~~~~~~~
114+
Basic Functions
115+
~~~~~~~~~~~~~~~
118116

119-
=============================================== ===========================================================
120-
Function Purpose
121-
=============================================== ===========================================================
122-
``efficiencies(m, d, lambda0, n_env=1)`` Calculate extinction, scattering, backscattering, asymmetry
123-
``intensities(m, d, lambda0, mu n_env=1)`` Angular scattering intensities for parallel/perpendicular polarization
124-
``S1_S2(m, x, mu)`` Complex scattering amplitudes
125-
``coefficients(m, x)`` Mie coefficients for field calculations
126-
``phase_matrix(m, x, mu)`` Mueller matrix for sphere
127-
=============================================== ===========================================================
117+
============================================ ===========================================================
118+
Function Purpose
119+
============================================ ===========================================================
120+
``efficiencies(m, d, lambda0, n_env=1)`` Calculate extinction, scattering, backscattering, asymmetry
121+
``intensities(m, d, lambda0, mu, n_env=1)`` Angular scattering intensities for parallel/perpendicular polarization
122+
``S1_S2(m, x, mu)`` Complex scattering amplitudes
123+
``coefficients(m, x)`` Mie coefficients for field calculations
124+
``phase_matrix(m, x, mu)`` Mueller matrix for sphere
125+
============================================ ===========================================================
128126

129127
Parameters
130128
~~~~~~~~~~
@@ -136,15 +134,6 @@ Parameters
136134
- **x** (float): Size parameter (π×diameter/wavelength)
137135
- **mu** (array): Cosine of scattering angles
138136

139-
Size Parameter Functions
140-
~~~~~~~~~~~~~~~~~~~~~~~~
141-
142-
For direct size parameter calculations:
143-
144-
.. code-block:: python
145-
146-
x = np.pi * diameter / wavelength
147-
qext, qsca, qback, g = mie.efficiencies_mx(m, x)
148137

149138
Performance & JIT Compilation
150139
-----------------------------
@@ -276,9 +265,9 @@ Documentation
276265
-------------
277266

278267
- **Full Documentation**: `miepython.readthedocs.io <https://miepython.readthedocs.io>`_
279-
- **API Reference**: Complete function documentation with examples
268+
- **API Reference**: `miepython api <https://miepython.readthedocs.io/en/latest/#api-reference>`_
280269
- **Theory Background**: Mathematical foundations and validation
281-
- **Example Gallery**: Interactive Jupyter notebooks
270+
- **Example Gallery**: `Interactive Jupyter notebooks <https://github.com/scottprahl/miepython/tree/main/docs>`_
282271

283272
Citation
284273
--------

0 commit comments

Comments
 (0)