.. modelarchive documentation master file, created by
   sphinx-quickstart on Fri Feb  6 09:30:06 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

modelarchive documentation
==========================

This is the `ModelArchive`_ Python package, providing the core functionality used by the `ModelArchive`_ team to handle, refine, and produce ModelCIF files. We may also add userland tooling for the database itself, in the future.

Currently, the package contains only the :mod:`~modelarchive.modelcif` submodule, which provides functionality for all aspects of ModelCIF.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modelcif


Credit
------

While at `ModelArchive`_, we develop the `ModelCIF mmCIF extension <https://mmcif.wwpdb.org/dictionaries/mmcif_ma.dic/Index/>`_ (alongside `other contributors <https://www.wwpdb.org/task/modelcif>`_), key functionality underlying our Python package comes from external developments: the |python-modelcif|_ and the |gemmi|_ packages.

* |python-modelcif|_ is brilliant in creating ModelCIF files from scratch

* |gemmi|_ is our go-to package for refining and updating existing ModelCIF files

..  LocalWords:  ModelCif userland modelarchive modelcif submodule toctree
..  LocalWords:  maxdepth gemmi