Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
scottprahl committed Jun 5, 2024
1 parent fb2f8f5 commit 29fc4e1
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
:alt: testing

.. |docs| image:: https://readthedocs.org/projects/pypolar/badge?color=68CA66
:target: https://pypolar.readthedocs.io
:alt: docs
:target: https://pypolar.readthedocs.io
:alt: docs

.. |down| image:: https://img.shields.io/pypi/dm/pypolar?color=68CA66
:target: https://pypi.org/project/pypolar/
Expand All @@ -35,18 +35,17 @@ pypolar

by Scott Prahl

|pypi| |github| |conda| |doi|
|pypi| |github| |conda| |doi|

|license| |test| |docs| |down|
|license| |test| |docs| |down|


``pypolar` is a python module to model and visualize the polarization state of light as it travels through polarizers and birefringent elements. Some ellipsometry support is also included.
``pypolar`` is a python module to model and visualize the polarization state of light as it travels through polarizers and birefringent elements. Some ellipsometry support is also included.

There are four numeric modules:

* `pypolar.fresnel` - reflection and transmission calculations
* `pypolar.jones` - management of polarization using the Jones calculus
* `pypolar.mueller` - management of polarization using the Mueller calculus
* `pypolar.mueller` - management of polarization using the Mueller calculus
* `pypolar.ellipsometry` - ellipsometry support

A module for visualization:
Expand All @@ -61,19 +60,17 @@ and three modules that support symbolic algebra:

Detailed documentation is available at `Read the Docs <https://pypolar.readthedocs.io>`_.

Installation
============

Use ``pip``::

pip install pypolar

or ``conda``::

conda install -c conda-forge pypolar


Usage
=====

Expand Down Expand Up @@ -122,6 +119,8 @@ will produce::

Create an optical isolator::

.. code-block:: python
import pypolar.mueller as mueller
# Optical Isolator example, no light returning
Expand Down

0 comments on commit 29fc4e1

Please sign in to comment.