.. _abi-pmr2-index:

============================
Auckland Physiome Repository
============================

The documentation found here is mainly aimed towards providing
information to users of the `Auckland Physiome Repository
<https://models.physiomeproject.org>`_.  This includes users interested
in obtaining and running models from the respository, and those who wish
to add models to the repository.

If you wish to deploy an instance of the repository software,
:term:`PMR2`, please see the `buildout repository`_ on GitHub.

.. toctree::
   :maxdepth: 1

   quickstart
   introduction
   downloading-viewing
   workingwithworkspaces
   cellmlrepositorytutorial
   semantic-metadata
   exposing-cellml
   exposing-fieldml
   embeddedworkspaces
   cellmlcuration
   webservice
   glossary

.. toctree::
   :hidden:

   teaching-instance-warning
   using-SED-ML

.. todo::

   - Update all documentation to reflect workspace ID changes and user
     workspace changes, if they go ahead.
   - Get embedded workspaces doc written.
   - Get some best practice docs written.

.. _buildout repository: https://github.com/PMR2/pmr2.buildout