.. include:: include/links.rst


The pycube API reference
========================

.. automodule:: pycube
   :members:

pycube
------

The cubeClass class
++++++++++++++++++++

.. automodule:: pycube.cubeClass
    :members:

The psf module
+++++++++++++++

.. automodule:: pycube.psf
    :members:

The halos module
++++++++++++++++

.. automodule:: pycube.halos
    :members:

pycube.core
-----------

The background module
+++++++++++++++++++++

.. automodule:: pycube.core.background
    :members:

The manip module
++++++++++++++++

.. automodule:: pycube.core.manip
    :members:

pycube.datacontainers
---------------------

datacontainer
++++++++++++++

.. automodule:: pycube.datacontainers.datacontainer
    :members:

datacube
++++++++

.. automodule:: pycube.datacontainers.datacube
    :members:

image
+++++

.. automodule:: pycube.datacontainers.image
    :members:

pycube.ancillary
----------------

checks
++++++

.. automodule:: pycube.ancillary.checks
    :members:

cleaning_lists
++++++++++++++

.. automodule:: pycube.ancillary.cleaning_lists
    :members:

pycube.instruments
------------------

instrument
++++++++++

.. automodule:: pycube.instruments.instrument
    :members:

vlt_muse
++++++++

.. automodule:: pycube.instruments.vlt_muse
    :members:

pycube.scripts
--------------

pycube_collapse
+++++++++++++++

.. automodule:: pycube.scripts.pycube_collapse
    :members:

pycube.test
-----------

test_ancillary
++++++++++++++

.. automodule:: pycube.test.test_ancillary
    :members:

test_msgs
+++++++++

.. automodule:: pycube.test.test_msgs
    :members: