Skip to content

Commit

Permalink
Update index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
bsumlin committed Jul 23, 2017
1 parent 88a4bc4 commit 901f8b8
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions index.rst/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,22 @@ You can install PyMieScatt from `PyPI <https://pypi.python.org/pypi/PyMieScatt>`
.. py:function:: MieQ(m, wavelength, diameter[, asDict=False])
Return Mie efficencies of a spherical particle with a given refractive index *m*, *wavelength*, and *diameter*. Optionally returns the parameters as a dict when *asDict* is specified and set to True.

.. py:Function:: Mie_ab(m,x)
Indices and tables
==================
Returns external field coefficients :math:`a_n` and :math:`b_n` based on inputs of *m* and :math:`x=\pi d/\lambda`. Typically not available as a top level call but can be specifically imported via::
$ from PyMieScatt import Mie_ab

.. py:Function:: Mie_cd(m,x)
Returns internal field coefficients :math:`c_n` and :math:`d_n` based on inputs of *m* and :math:`x=\pi d/\lambda`. Typically not available as a top level call but can be specifically imported via::
$ from PyMieScatt import Mie_cd

.. py:Function:: RayleighMieQ(m, wavelength, diameter[, asDict=False])
Returns Mie efficencies of a spherical particle in the Rayleigh regime (:math:`x=\pi d/\lambda << 1`) given refractive index *m*, *wavelength*, and *diameter*. Optionally returns the parameters as a dict when *asDict* is specified and set to True. Uses :py:func:`RayleighMie_ab` to calculate :math:`a_n` and :math:`b_n`.

.. py:Function::`LowFrequencyMieQ(m, wavelength, diameter[, asDict=False])
Returns Mie efficencies of a spherical particle in the low-frequency regime given refractive index *m*, *wavelength*, and *diameter*. Optionally returns the parameters as a dict when *asDict* is specified and set to True. Uses :py:func:`LowFrequencyMie_ab` to calculate :math:`a_n` and :math:`b_n`.

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit 901f8b8

Please sign in to comment.