.. _api-reference:

API Reference
-------------

This is the documentation for the application programming interface (API) provided
in the python package :code:`scale.olm`.

.. note::

    For documentation of the command line utility :code:`olm`, see :ref:`cli-reference`.

------------------------------------------------------------------------------------------

.. automodule:: scale.olm
    :members:

.. toctree::
	:hidden:
	:caption: library creation

	modules/generate
	modules/assemble
	modules/run
	modules/check
	modules/report

.. toctree::
	:hidden:
	:caption: other

	modules/core
	modules/contrib
	modules/internal