API Reference
=============

This section documents the classes, functions, etc. provided by |project-bf|. For examples of common operations, see :doc:`../user_guide/index`.


.. toctree::
   :maxdepth: 2

   molcube.pdbreader
   molcube.solution_builder
   molcube.membrane_builder
   molcube.ligand_modeler
   molcube.free_energy

Low-level details
-----------------

molcube.api
^^^^^^^^^^^

Low level client methods.

.. automodule:: molcube.api
   :members:
   :show-inheritance:
   :undoc-members:

molcube.base
^^^^^^^^^^^^

Common definitions for MolCube projects.

.. automodule:: molcube.base
   :members:
   :show-inheritance:
   :undoc-members:

molcube.models
^^^^^^^^^^^^^^

Validation schemata for requests sent to MolCube servers.

.. automodule:: molcube.models
   :members:
   :show-inheritance:
   :undoc-members:

molcube.typed\_dicts
^^^^^^^^^^^^^^^^^^^^

Definitions for static type checkers and language servers.

.. automodule:: molcube.typed_dicts
   :members:
   :show-inheritance:
   :undoc-members:

molcube.utils
^^^^^^^^^^^^^

.. automodule:: molcube.utils
   :members:
   :show-inheritance:
   :undoc-members: