..
   Copyright 2026 SIB - Swiss Institute of Bioinformatics and Biozentrum -
   University of Basel
   Copying and distribution of this file, with or without modification, are
   permitted provided the copyright notice and this notice are preserved.

..
   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.

For real-world usage examples, browse our `modelcif-converters <https://git.scicore.unibas.ch/schwede/modelcif-converters>`_ repository. `/projects <https://git.scicore.unibas.ch/schwede/modelcif-converters/-/tree/main/projects?ref_type=heads>`_ contains a list of "modelling project to ModelCIF files" conversions from the past. The latter ones should use this package.

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

   databases
   modelcif
   tools


Credit
------

While at `ModelArchive`_, we develop the `ModelCIF`_ mmCIF extension (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