API documentation
=================

.. autosummary::
   :toctree: _autosummary
   :recursive:

   pyopia

----

**Content**

* `CLI`_
* `Pipeline`_
* `Background`_
* `Process`_
* `Statistics`_
* `Plotting`_
* `IO`_
* `Classify`_
* `ExampleData`_

**Instrument-Specific**

* `SilCam`_
* `Holo`_
* `UVP`_

**Simulators**

* `SilCam-Simulator`_

**Indices and tables**

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


----

CLI
--------------
.. automodule:: pyopia.cli
    :members:

Pipeline
--------------
.. automodule:: pyopia.pipeline
    :members:

Background
--------------
.. automodule:: pyopia.background
    :members:

Process
--------------
.. automodule:: pyopia.process
    :members:

Statistics
--------------
.. automodule:: pyopia.statistics
    :members:

Plotting
--------------
.. automodule:: pyopia.plotting
    :members:

IO
--------------
.. automodule:: pyopia.io
    :members:

Classify
--------------
.. automodule:: pyopia.classify
    :members:

ExampleData
--------------
.. automodule:: pyopia.exampledata
    :members:

Instruments
==================
SilCam
--------------
.. automodule:: pyopia.instrument.silcam
    :members:

Holo
--------------
.. automodule:: pyopia.instrument.holo
    :members:

UVP
--------------
.. automodule:: pyopia.instrument.uvp
    :members:

Common
-------------
.. automodule:: pyopia.instrument.common
    :members:

Simulators
==================
Silcam-Simulator
--------------
.. automodule:: pyopia.simulator.silcam
    :members: