Python-IHM documentation
========================

This is a Python package to assist in handling mmCIF files compliant
with the integrative/hybrid modeling (IHM) extension.

The documentation below documents the library API. For complete worked examples,
see `the examples directory at GitHub <https://github.com/ihmwg/python-ihm/tree/main/examples>`_
or real systems deposited using the library, such as
`Nup133 <https://github.com/integrativemodeling/nup133/tree/main/outputs_foxs_ensemble_new/pdb-dev>`_.

Contents
========

.. toctree::
   :maxdepth: 2

   introduction
   usage
   provenance
   design
   lowlevel
   changes

API Reference:

.. toctree::
   :maxdepth: 1

   main
   source
   reference
   location
   dataset
   metadata
   startmodel
   representation
   geometry
   restraint
   cross_linkers
   citations
   protocol
   analysis
   model
   format
   format_bcif
   dumper
   reader
   dictionary
   flr
   multi_state_scheme


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

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