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

This is the definite source of information for developers, besides having a look at the actual source code. Each class and public method should be fully documented.

To get a more high-level overview of the overall package architecture first, you may have a look at the separate :doc:`architecture <../architecture>` section of the documentation. And just in case that you would like to contribute to the package, make sure to check out the :doc:`contribution guidelines <../contributing>`.


Modules
-------

An alphabetic list of the modules available within the ocdb package. The actual documentation is split in pages for each module, respectively.

.. toctree::
    :maxdepth: 1

    ocdb.io
    ocdb.management
    ocdb.material
    ocdb.plotting
    ocdb.processing
    ocdb.report