miepython 3.0.2__tar.gz → 3.0.3__tar.gz

miepython-3.0.3/CITATION.cff

@@ -0,0 +1,42 @@
+cff-version: 1.2.0
+type: software
+message: If you use this software, please cite it as below.
+title: 'miepython: Pure python calculation of Mie scattering'
+version: 3.0.3
+doi: 10.5281/zenodo.7949264
+date-released: '2026-01-02'
+url: https://doi.org/10.5281/zenodo.7949264
+repository-code: https://github.com/scottprahl/miepython
+license: MIT
+authors:
+- family-names: Prahl
+  given-names: Scott
+  orcid: https://orcid.org/0000-0003-1468-6851
+abstract: miepython provides a validated and efficient pure python implementation
+  of  Mie scattering for spherical particles.  It reproduces established reference
+  results  (including Wiscombe's MIEV0) and is designed for scientific, educational,
+  and  computational research applications in optics.
+keywords:
+- mie
+- scattering
+- rainbow
+- droplet
+- backscatter
+- sphere
+- nanoparticle
+- cloud
+- phase function
+- efficiency
+- rayleigh
+- backscattering
+preferred-citation:
+  type: software
+  title: 'miepython: Pure python calculation of Mie scattering'
+  year: 2026
+  version: 3.0.3
+  doi: 10.5281/zenodo.7949264
+  url: https://doi.org/10.5281/zenodo.7949264
+  authors:
+  - family-names: Prahl
+    given-names: Scott
+    orcid: https://orcid.org/0000-0003-1468-6851

miepython-3.0.3/MANIFEST.in

@@ -0,0 +1,8 @@
+# Core package files
+include LICENSE.txt
+include README.rst
+include CHANGELOG.rst
+include CITATION.cff
+
+# Package data needed at runtime
+include miepython/data/*.txt

miepython-3.0.3/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: miepython
+Version: 3.0.3
+Summary: Mie scattering of a plane wave by a sphere
+Author-email: Scott Prahl <scott.prahl@oit.edu>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/scottprahl/miepython
+Project-URL: Documentation, https://miepython.readthedocs.io
+Project-URL: Source, https://github.com/scottprahl/miepython
+Project-URL: Tracker, https://github.com/scottprahl/miepython/issues
+Project-URL: Changelog, https://github.com/scottprahl/miepython/blob/main/docs/CHANGELOG.rst
+Keywords: mie,scattering,rainbow,droplet,backscatter,sphere,nanoparticle,cloud,phase function,efficiency,rayleigh,backscattering
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: numba
+Requires-Dist: scipy
+Dynamic: license-file
+
+.. |pypi| image:: https://img.shields.io/pypi/v/miepython?color=68CA66
+   :target: https://pypi.org/project/miepython/
+   :alt: PyPI
+
+.. |github| image:: https://img.shields.io/github/v/tag/scottprahl/miepython?label=github&color=68CA66
+   :target: https://github.com/scottprahl/miepython
+   :alt: GitHub
+
+.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/miepython?label=conda&color=68CA66
+   :target: https://github.com/conda-forge/miepython-feedstock
+   :alt: Conda
+
+.. |doi| image:: https://zenodo.org/badge/99259684.svg
+   :target: https://zenodo.org/badge/latestdoi/99259684
+   :alt: DOI
+
+.. |license| image:: https://img.shields.io/github/license/scottprahl/miepython?color=68CA66
+   :target: https://github.com/scottprahl/miepython/blob/master/LICENSE.txt
+   :alt: License
+
+.. |test| image:: https://github.com/scottprahl/miepython/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/scottprahl/miepython/actions/workflows/test.yml
+   :alt: Testing
+
+.. |docs| image:: https://readthedocs.org/projects/miepython/badge?color=68CA66
+   :target: https://miepython.readthedocs.io
+   :alt: Docs
+
+.. |downloads| image:: https://img.shields.io/pypi/dm/miepython?color=68CA66
+   :target: https://pypi.org/project/miepython/
+   :alt: Downloads
+
+.. |lite| image:: https://img.shields.io/badge/try-JupyterLite-68CA66.svg
+   :target: https://scottprahl.github.io/miepython/
+   :alt: Try JupyterLite
+
+
+miepython
+=========
+
+|pypi| |github| |conda| |doi|  
+
+|license| |test| |docs| |downloads|  
+
+|lite|
+
+Mie scattering calculations in pure Python
+------------------------------------------
+
+``miepython`` provides a validated and efficient implementation of Mie scattering for spherical particles.  
+It reproduces established reference results (including Wiscombe's MIEV0) and is designed for scientific, educational, and computational research applications in optics.
+
+The library implements the full Mie solution, including:
+
+- extinction, scattering, and absorption efficiencies
+- asymmetry parameter (scattering anisotropy)
+- angle-resolved scattering intensities
+- Mie expansion coefficients
+- complex amplitude functions and Mueller matrices
+
+The implementation is numerically stable for a wide range of size parameters and refractive indices, including lossy materials and high-index contrasts.
+
+Immediate Use in the Browser
+----------------------------
+
+The entire package can be used **immediately** in a browser — without installation — using the JupyterLite interface:
+
+|lite|
+
+This environment runs entirely client-side (Pyodide), and supports:
+
+- interactive notebooks  
+- real-time plotting  
+- full access to ``miepython`` functions  
+- reproducible experiments (downloadable notebooks)
+
+This makes it ideal for teaching, demonstrations, or quick exploratory calculations.
+
+Installation
+------------
+
+Install with pip:
+
+.. code-block:: bash
+
+    pip install miepython
+
+Or via conda:
+
+.. code-block:: bash
+
+    conda install -c conda-forge miepython
+
+Quick Start
+-----------
+
+A typical calculation is straightforward:
+
+.. code-block:: python
+
+    import miepython as mie
+
+    m = 1.5 - 0.1j     # refractive index
+    d = 100            # diameter (nm)
+    lambda0 = 314.15   # wavelength (nm)
+
+    qext, qsca, qback, g = mie.efficiencies(m, d, lambda0)
+
+Documentation and Examples
+--------------------------
+
+The full documentation is available as:
+
+Interactive documentation (JupyterLite):
+    |lite|
+
+Static Jupyter notebooks on ReadTheDocs:
+    |docs|
+
+Among other things the documentation discusses:
+
+- **Mathematical formulation of Mie theory**  
+  https://miepython.readthedocs.io/en/latest/01_theory.html
+
+- **Normalization conventions and units**  
+  https://miepython.readthedocs.io/en/latest/02_normalization.html
+
+- **Numerical stability considerations**  
+  https://miepython.readthedocs.io/en/latest/03_stability.html
+
+- **Validation against MIEV0 and other reference implementations**  
+  https://miepython.readthedocs.io/en/latest/04_validation.html
+
+- **Guidelines for parameter choices and truncation order**  
+  https://miepython.readthedocs.io/en/latest/05_truncation.html
+
+- **Physical interpretation, resonances, and comparison plots**  
+  https://miepython.readthedocs.io/en/latest/06_examples.html
+
+Representative results simple examples:
+
+    https://github.com/scottprahl/miepython/tree/main/miepython/examples
+
+.. image:: https://raw.githubusercontent.com/scottprahl/miepython/main/docs/images/01.svg
+.. image:: https://raw.githubusercontent.com/scottprahl/miepython/main/docs/images/02.svg
+.. image:: https://raw.githubusercontent.com/scottprahl/miepython/main/docs/images/03.svg
+.. image:: https://raw.githubusercontent.com/scottprahl/miepython/main/docs/images/04.svg
+
+Performance and Acceleration
+----------------------------
+
+``miepython`` supports optional Numba JIT compilation:
+
+.. code-block:: python
+
+    import os
+    os.environ["MIEPYTHON_USE_JIT"] = "1"  # must be set before import
+    import miepython
+
+This can provide 10–50× speedups for large parameter sweeps or ensemble calculations.
+
+Benchmark example (100,000 particles):
+
+============ ============ ==========
+Version      Time         Speedup
+============ ============ ==========
+Pure Python  4.00 s       1×
+JIT Enabled  0.15 s       27×
+============ ============ ==========
+
+Citation
+--------
+
+If you use ``laserbeamsize`` in academic, instructional, or applied technical work, please cite:
+
+Prahl, S. (2026). *miepython: Pure python calculation of Mie scattering* (Version 3.0.3) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.7949263
+
+BibTeX:
+
+.. code-block:: bibtex
+
+    @software{prahl_miepython_2025,
+      author  = {Scott Prahl},
+      title   = {{miepython}: A Python library for Mie scattering calculations},
+      url     = {https://github.com/scottprahl/miepython},
+      doi     = {10.5281/zenodo.7949263},
+      year    = {2026},
+      version = {3.0.3},
+      publisher = {Zenodo}
+    }
+
+License
+-------
+
+``miepython`` is released under the MIT License.
+

miepython-3.0.3/README.rst

@@ -0,0 +1,196 @@
+.. |pypi| image:: https://img.shields.io/pypi/v/miepython?color=68CA66
+   :target: https://pypi.org/project/miepython/
+   :alt: PyPI
+
+.. |github| image:: https://img.shields.io/github/v/tag/scottprahl/miepython?label=github&color=68CA66
+   :target: https://github.com/scottprahl/miepython
+   :alt: GitHub
+
+.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/miepython?label=conda&color=68CA66
+   :target: https://github.com/conda-forge/miepython-feedstock
+   :alt: Conda
+
+.. |doi| image:: https://zenodo.org/badge/99259684.svg
+   :target: https://zenodo.org/badge/latestdoi/99259684
+   :alt: DOI
+
+.. |license| image:: https://img.shields.io/github/license/scottprahl/miepython?color=68CA66
+   :target: https://github.com/scottprahl/miepython/blob/master/LICENSE.txt
+   :alt: License
+
+.. |test| image:: https://github.com/scottprahl/miepython/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/scottprahl/miepython/actions/workflows/test.yml
+   :alt: Testing
+
+.. |docs| image:: https://readthedocs.org/projects/miepython/badge?color=68CA66
+   :target: https://miepython.readthedocs.io
+   :alt: Docs
+
+.. |downloads| image:: https://img.shields.io/pypi/dm/miepython?color=68CA66
+   :target: https://pypi.org/project/miepython/
+   :alt: Downloads
+
+.. |lite| image:: https://img.shields.io/badge/try-JupyterLite-68CA66.svg
+   :target: https://scottprahl.github.io/miepython/
+   :alt: Try JupyterLite
+
+
+miepython
+=========
+
+|pypi| |github| |conda| |doi|  
+
+|license| |test| |docs| |downloads|  
+
+|lite|
+
+Mie scattering calculations in pure Python
+------------------------------------------
+
+``miepython`` provides a validated and efficient implementation of Mie scattering for spherical particles.  
+It reproduces established reference results (including Wiscombe's MIEV0) and is designed for scientific, educational, and computational research applications in optics.
+
+The library implements the full Mie solution, including:
+
+- extinction, scattering, and absorption efficiencies
+- asymmetry parameter (scattering anisotropy)
+- angle-resolved scattering intensities
+- Mie expansion coefficients
+- complex amplitude functions and Mueller matrices
+
+The implementation is numerically stable for a wide range of size parameters and refractive indices, including lossy materials and high-index contrasts.
+
+Immediate Use in the Browser
+----------------------------
+
+The entire package can be used **immediately** in a browser — without installation — using the JupyterLite interface:
+
+|lite|
+
+This environment runs entirely client-side (Pyodide), and supports:
+
+- interactive notebooks  
+- real-time plotting  
+- full access to ``miepython`` functions  
+- reproducible experiments (downloadable notebooks)
+
+This makes it ideal for teaching, demonstrations, or quick exploratory calculations.
+
+Installation
+------------
+
+Install with pip:
+
+.. code-block:: bash
+
+    pip install miepython
+
+Or via conda:
+
+.. code-block:: bash
+
+    conda install -c conda-forge miepython
+
+Quick Start
+-----------
+
+A typical calculation is straightforward:
+
+.. code-block:: python
+
+    import miepython as mie
+
+    m = 1.5 - 0.1j     # refractive index
+    d = 100            # diameter (nm)
+    lambda0 = 314.15   # wavelength (nm)
+
+    qext, qsca, qback, g = mie.efficiencies(m, d, lambda0)
+
+Documentation and Examples
+--------------------------
+
+The full documentation is available as:
+
+Interactive documentation (JupyterLite):
+    |lite|
+
+Static Jupyter notebooks on ReadTheDocs:
+    |docs|
+
+Among other things the documentation discusses:
+
+- **Mathematical formulation of Mie theory**  
+  https://miepython.readthedocs.io/en/latest/01_theory.html
+
+- **Normalization conventions and units**  
+  https://miepython.readthedocs.io/en/latest/02_normalization.html
+
+- **Numerical stability considerations**  
+  https://miepython.readthedocs.io/en/latest/03_stability.html
+
+- **Validation against MIEV0 and other reference implementations**  
+  https://miepython.readthedocs.io/en/latest/04_validation.html
+
+- **Guidelines for parameter choices and truncation order**  
+  https://miepython.readthedocs.io/en/latest/05_truncation.html
+
+- **Physical interpretation, resonances, and comparison plots**  
+  https://miepython.readthedocs.io/en/latest/06_examples.html
+
+Representative results simple examples:
+
+    https://github.com/scottprahl/miepython/tree/main/miepython/examples
+
+.. image:: https://raw.githubusercontent.com/scottprahl/miepython/main/docs/images/01.svg
+.. image:: https://raw.githubusercontent.com/scottprahl/miepython/main/docs/images/02.svg
+.. image:: https://raw.githubusercontent.com/scottprahl/miepython/main/docs/images/03.svg
+.. image:: https://raw.githubusercontent.com/scottprahl/miepython/main/docs/images/04.svg
+
+Performance and Acceleration
+----------------------------
+
+``miepython`` supports optional Numba JIT compilation:
+
+.. code-block:: python
+
+    import os
+    os.environ["MIEPYTHON_USE_JIT"] = "1"  # must be set before import
+    import miepython
+
+This can provide 10–50× speedups for large parameter sweeps or ensemble calculations.
+
+Benchmark example (100,000 particles):
+
+============ ============ ==========
+Version      Time         Speedup
+============ ============ ==========
+Pure Python  4.00 s       1×
+JIT Enabled  0.15 s       27×
+============ ============ ==========
+
+Citation
+--------
+
+If you use ``laserbeamsize`` in academic, instructional, or applied technical work, please cite:
+
+Prahl, S. (2026). *miepython: Pure python calculation of Mie scattering* (Version 3.0.3) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.7949263
+
+BibTeX:
+
+.. code-block:: bibtex
+
+    @software{prahl_miepython_2025,
+      author  = {Scott Prahl},
+      title   = {{miepython}: A Python library for Mie scattering calculations},
+      url     = {https://github.com/scottprahl/miepython},
+      doi     = {10.5281/zenodo.7949263},
+      year    = {2026},
+      version = {3.0.3},
+      publisher = {Zenodo}
+    }
+
+License
+-------
+
+``miepython`` is released under the MIT License.
+

{miepython-3.0.2 → miepython-3.0.3}/miepython/__init__.py

@@ -58,6 +58,9 @@ if USE_JIT:
     from .mie_jit import _pi_tau_nb as _pi_tau
     from .mie_jit import _D_calc_nb as _D_calc
     from .mie_jit import _S1_S2_nb as _S1_S2
+    from .mie_jit import _Lentz_Dn
+    from .mie_jit import _D_upwards
+    from .mie_jit import _D_downwards
 else:
     from .mie_nojit import _an_bn_py as an_bn
     from .mie_nojit import _cn_dn_py as cn_dn
@@ -67,6 +70,9 @@ else:
     from .mie_nojit import _pi_tau_py as _pi_tau
     from .mie_nojit import _D_calc_py as _D_calc
     from .mie_nojit import _S1_S2_py as _S1_S2
+    from .mie_nojit import _Lentz_Dn
+    from .mie_nojit import _D_upwards
+    from .mie_nojit import _D_downwards
 
 from .core import efficiencies, intensities, i_par, i_per, i_unpolarized
 from .core import efficiencies_mx, S1_S2, phase_matrix, coefficients
@@ -90,11 +96,14 @@ __all__ = (
     "_S1_S2",
     "_D_calc",
     "_pi_tau",
+    "_Lentz_Dn",
+    "_D_upwards",
+    "_D_downwards",
 )
 
-__version__ = "3.0.2"
+__version__ = "3.0.3"
 __author__ = "Scott Prahl"
 __email__ = "scott.prahl@oit.edu"
-__copyright__ = "2017-25, Scott Prahl"
+__copyright__ = "2017-26, Scott Prahl"
 __license__ = "MIT"
 __url__ = "https://github.com/scottprahl/miepython.git"

{miepython-3.0.2 → miepython-3.0.3}/miepython/core.py

@@ -135,7 +135,7 @@ def coefficients(m, x, n_pole=0, internal=False):
     return np.array([a, b])
 
 
-def efficiencies_mx(m, x, n_pole=0, field="Electric"):
+def efficiencies_mx(m, x, n_pole=0, e_field=True):
     """
     Computes scattering and extinction efficiencies for a spherical particle using Mie theory.
 
@@ -155,8 +155,8 @@ def efficiencies_mx(m, x, n_pole=0, field="Electric"):
             Multipole order to compute:
             - If 0 (default), computes contributions from all multipoles.
             - If non-zero, computes contributions from the specified multipole order.
-        field (str):
-            If "Electric" (default) If n_pole>0, then True value returns the electric
+        e_field (boolean):
+            If n_pole>0, then True value returns the electric
             multipole contribution otherwise the Magnetic field contribution
     Returns:
         tuple:
@@ -210,7 +210,7 @@ def efficiencies_mx(m, x, n_pole=0, field="Electric"):
         xlen = len(x)
 
     if mlen == 0 and xlen == 0:
-        return single_sphere(m, x, n_pole)
+        return single_sphere(m, x, n_pole, e_field)
 
     if xlen > 0 and mlen > 0 and xlen != mlen:
         raise RuntimeError("m and x arrays to mie must be same length")
@@ -230,7 +230,7 @@ def efficiencies_mx(m, x, n_pole=0, field="Electric"):
         if xlen > 0:
             xx = x[i]
 
-        qext[i], qsca[i], qback[i], g[i] = single_sphere(mm, xx, n_pole)
+        qext[i], qsca[i], qback[i], g[i] = single_sphere(mm, xx, n_pole, e_field)
 
     return qext, qsca, qback, g
 
@@ -260,7 +260,7 @@ def normalization_factor(m, x, norm_str):
         factor = x * np.sqrt(np.pi)
 
     else:
-        qext, qsca, _, _ = single_sphere(m, x, 0)
+        qext, qsca, _, _ = single_sphere(m, x, 0, True)
 
         if norm in ["a", "albedo"]:
             factor = x * np.sqrt(np.pi * qext)
@@ -276,8 +276,7 @@ def normalization_factor(m, x, norm_str):
 
     if factor is None:
         raise ValueError(
-            "normalization must be one of 'albedo' (default), 'one'"
-            "'4pi', 'qext', 'qsca', 'bohren', or 'wiscombe'"
+            "normalization must be one of 'albedo' (default), 'one', '4pi', 'qext', 'qsca', 'bohren', or 'wiscombe'"
         )
     return factor
 

{miepython-3.0.2 → miepython-3.0.3}/miepython/mie_jit.py

@@ -3,7 +3,7 @@ Low-level Mie calculations that use numba.
 """
 
 import numpy as np
-from numba import njit, complex128, float64, int64
+from numba import njit, complex128, float64, int64, boolean
 
 __all__ = (
     "_D_calc_nb",
@@ -366,9 +366,7 @@ def _small_conducting_sphere_nb(_m, x):
     ahat2 = complex(0.0, x**2 / 30.0)
     bhat2 = complex(0.0, -(x**2) / 45.0)
 
-    qsca = x**4 * (
-        6 * np.abs(ahat1) ** 2 + 6 * np.abs(bhat1) ** 2 + 10 * np.abs(ahat2) ** 2 + 10 * np.abs(bhat2) ** 2
-    )
+    qsca = x**4 * (6 * np.abs(ahat1) ** 2 + 6 * np.abs(bhat1) ** 2 + 10 * np.abs(ahat2) ** 2 + 10 * np.abs(bhat2) ** 2)
     qext = qsca
     g = ahat1.imag * (ahat2.imag + bhat1.imag)
     g += bhat2.imag * (5.0 / 9.0 * ahat2.imag + bhat1.imag)
@@ -428,8 +426,8 @@ def _small_sphere_nb(m, x):
     return qext, qsca, qback, g
 
 
-@njit((complex128, float64, int64), cache=True, fastmath=True)
-def _single_sphere_nb(m, x, n_pole):
+@njit((complex128, float64, int64, boolean), cache=True, fastmath=True)
+def _single_sphere_nb(m, x, n_pole, e_field):
     """
     Calculate the efficiencies for a single sphere (both m and x are scalars).
 
@@ -445,6 +443,8 @@ def _single_sphere_nb(m, x, n_pole):
         qback: the backscatter efficiency
         g: the average cosine of the scattering phase function
     """
+    e_field = not e_field  # unused
+
     # case when sphere matches its environment
     if abs(m.real - 1) <= 1e-8 and abs(m.imag) < 1e-8:
         return 0, 0, 0, 0

{miepython-3.0.2 → miepython-3.0.3}/miepython/mie_nojit.py

@@ -354,9 +354,7 @@ def _small_conducting_sphere_py(_m, x):
     ahat2 = complex(0.0, x**2 / 30.0)
     bhat2 = complex(0.0, -(x**2) / 45.0)
 
-    qsca = x**4 * (
-        6 * np.abs(ahat1) ** 2 + 6 * np.abs(bhat1) ** 2 + 10 * np.abs(ahat2) ** 2 + 10 * np.abs(bhat2) ** 2
-    )
+    qsca = x**4 * (6 * np.abs(ahat1) ** 2 + 6 * np.abs(bhat1) ** 2 + 10 * np.abs(ahat2) ** 2 + 10 * np.abs(bhat2) ** 2)
     qext = qsca
     g = ahat1.imag * (ahat2.imag + bhat1.imag)
     g += bhat2.imag * (5.0 / 9.0 * ahat2.imag + bhat1.imag)
@@ -415,7 +413,7 @@ def _small_sphere_py(m, x):
     return qext, qsca, qback, g
 
 
-def _single_sphere_py(m, x, n_pole):
+def _single_sphere_py(m, x, n_pole, e_field):
     """
     Calculate the efficiencies for a sphere when both m and x are scalars.
 
@@ -431,6 +429,8 @@ def _single_sphere_py(m, x, n_pole):
         qback: the backscatter efficiency
         g: the average cosine of the scattering phase function
     """
+    e_field = not e_field  # unused
+
     # case when sphere matches its environment
     if abs(m.real - 1) <= 1e-8 and abs(m.imag) < 1e-8:
         return 0, 0, 0, 0

{miepython-3.0.2 → miepython-3.0.3}/miepython/rayleigh.py

@@ -101,8 +101,7 @@ def normalization_factor(m, x, norm_str):
 
     if factor is None:
         raise ValueError(
-            "normalization must be one of 'albedo' (default), 'one'"
-            "'4pi', 'qext', 'qsca', 'bohren', or 'wiscombe'"
+            "normalization must be one of 'albedo' (default), 'one', '4pi', 'qext', 'qsca', 'bohren', or 'wiscombe'"
         )
     return factor