Skip to content

Commit e7ffa3c

Browse files
committed
updates for release
1 parent e68f6bb commit e7ffa3c

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

README.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,39 +46,44 @@ by Scott Prahl
4646
________
4747

4848
``miepython`` is a pure Python module to calculate light scattering for
49-
non-absorbing, partially-absorbing, or perfectly-conducting spheres. Mie
50-
theory is used, following `the procedure described by Wiscombe
51-
<http://opensky.ucar.edu/islandora/object/technotes:232>`_. This code has
52-
been validated against his results.
49+
non-absorbing, partially-absorbing, or perfectly-conducting spheres.
5350

5451
This code provides functions for calculating the extinction efficiency,
5552
scattering efficiency, backscattering, and scattering asymmetry. Moreover, a set
5653
of angles can be given to calculate the scattering for a sphere at each of those
5754
angles.
5855

56+
Mie computations are done following `the procedure described by Wiscombe
57+
<http://opensky.ucar.edu/islandora/object/technotes:232>`_. This code has
58+
been validated against his results.
59+
5960
Full documentation at <https://miepython.readthedocs.io>
6061

61-
Version 3 changes (in progress)
62-
--------------------------------
62+
Version 3 changes
63+
-----------------
6364

6465
This version contains major changes to the code base and **has API breaking changes**.
6566
If you don't need the new functionality for fields, then you can continue to use the
6667
last version with the old API: 2.5.5
6768

68-
Version 3.0 has many changes, but the major changes are:
69+
Version 3.0 has many changes, but the major ones are:
6970

7071
* a complete overhaul of API
7172
* added support to calculate Mie coefficients for fields inside sphere
72-
* added support for calculating electric and magnetic fields
73+
* future work will implement calculating electric and magnetic fields
7374

7475
Pay Attention!
7576
--------------
7677

77-
When comparing different Mie scattering codes, make sure that you're aware of the conventions used by each code. ``miepython`` makes the following assumptions
78+
When comparing different Mie scattering codes, make sure that you're aware of the conventions used by each code. ``miepython`` makes the following assumptions:
79+
80+
#. The imaginary part of the complex index of refraction for absorbing spheres is *negative*.
81+
Currently if you pass refractive indicies with a positive imaginary value, the refractive
82+
index is silently converted to a negative value before calculation.
7883

79-
#. the imaginary part of the complex index of refraction for absorbing spheres is *negative*.
84+
#. The scattering phase function is normalized so it equals the *single scattering albedo* when
85+
integrated over 4π steradians. The default normalization can now be changed.
8086

81-
#. the scattering phase function is normalized so it equals the *single scattering albedo* when integrated over 4π steradians. As of version 2.3, this can be changed.
8287

8388
Installation
8489
---------------
@@ -142,4 +147,3 @@ License
142147
-------
143148

144149
``miepython`` is licensed under the terms of the MIT license.
145-

0 commit comments

Comments
 (0)