Python-ModelCIF documentation
=============================

This is a Python package to assist in handling mmCIF files compliant
with the ModelCIF extension.

The documentation below documents the library API. For complete worked examples,
see `the examples directory at GitHub <https://github.com/ihmwg/python-modelcif/tree/main/examples>`_.

Contents
========

.. toctree::
   :maxdepth: 2

   introduction
   usage
   limitations
   changes

API Reference:

.. toctree::
   :maxdepth: 1

   main
   reference
   alignment
   data
   protocol
   model
   qa_metric
   associated
   descriptor
   dumper
   reader
   

Indices and tables
==================

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