You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+16-12Lines changed: 16 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,39 +46,44 @@ by Scott Prahl
46
46
________
47
47
48
48
``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.
53
50
54
51
This code provides functions for calculating the extinction efficiency,
55
52
scattering efficiency, backscattering, and scattering asymmetry. Moreover, a set
56
53
of angles can be given to calculate the scattering for a sphere at each of those
57
54
angles.
58
55
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
+
59
60
Full documentation at <https://miepython.readthedocs.io>
60
61
61
-
Version 3 changes (in progress)
62
-
--------------------------------
62
+
Version 3 changes
63
+
-----------------
63
64
64
65
This version contains major changes to the code base and **has API breaking changes**.
65
66
If you don't need the new functionality for fields, then you can continue to use the
66
67
last version with the old API: 2.5.5
67
68
68
-
Version 3.0 has many changes, but the major changes are:
69
+
Version 3.0 has many changes, but the major ones are:
69
70
70
71
* a complete overhaul of API
71
72
* 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
73
74
74
75
Pay Attention!
75
76
--------------
76
77
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.
78
83
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.
80
86
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.
82
87
83
88
Installation
84
89
---------------
@@ -142,4 +147,3 @@ License
142
147
-------
143
148
144
149
``miepython`` is licensed under the terms of the MIT license.
0 commit comments