.. _PMR-index:

=============================
The Physiome Model Repository
=============================

The documentation found here is mainly aimed towards providing information to users of the `Physiome Model Repository <http://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, PMR Software, please see the `buildout repository`_ on GitHub.

.. toctree::
   :maxdepth: 1

   PMR-introduction
   PMR-downloading-viewing
   PMR-workingwithworkspaces
   PMR-cellmlrepositorytutorial
   PMR-exposing-cellml
   PMR-exposing-fieldml
   PMR-embeddedworkspaces
   PMR-cellmlcuration

.. toctree::
   :hidden:

   PMR-teaching-instance-warning
   PMR-using-SED-ML

.. todo::

   * Update all PMR 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/PMR/pmr2.buildout