.. _how to use the hub: https://todo/

.. _development manual: https://todo/

.. _catalogs manual: https://todo

.. |alert| image:: ./_static/alert.png
  :width: 15
  :alt: Alert

.. |cat| image:: ./_static/cat.png
  :width: 30
  :alt: Cat

CERC PERSISTENCE' reference manual
=====================================
.. toctree::
   :maxdepth: 4
   :caption: Contents:

CERC PERSISTENCE' reference manual
=====================================
Authors
*************************

* Peter Yefi
* Guillermo Gutierrez Morote

Contributors
*************************

* Ruben Sanchez

About the PERSISTENCE
*************************

This document contains the essential documentation for the cerc persistence package, a set of classes, that allows the permanent storage of a cec_hub city.
cerc persistence package is composed of two main components: **repositories** and **models**.

Folder structure
******************

.. image:: ./cerc_persistence.png
   :width: 400

Model Classes
****************************

Application
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.application.Application
   :members:

City
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.city.City
   :members:

CityObject
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.city_object.CityObject
   :members:


SimulationResults
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.simulation_results.SimulationResults
   :members:


User
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.models.user.User
   :members:


Repository Classes
****************************

Application
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.repositories.application.Application
   :members:

City
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.repositories.city.City
   :members:

CityObject
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.repositories.city_object.CityObject
   :members:


SimulationResults
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.repositories.simulation_results.SimulationResults
   :members:


User
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.repositories.user.User
   :members:

Classes
****************************

Configuration
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.configuration.Configuration
   :members:

DB Control
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.db_control.DBControl
   :members:

DB Setup
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.db_setup.DBSetup
   :members:

Repository
^^^^^^^^^^^^^^^^^^^^^^
.. autocercclass:: cerc_persistence.repository.Repository
   :members:

Additional Files
====================

Readme
***********

`README.md <https://rs-loy-gitlab.concordia.ca/Guille/hub/-/blob/master/README.md>`_

License
************

`LICENSE.md <https://rs-loy-gitlab.concordia.ca/Guille/hub/-/blob/master/LICENSE.md>`_

Code of conduct
************************

`CODE_OF_CONDUCT.md <https://rs-loy-gitlab.concordia.ca/Guille/hub/-/blob/master/CODE_OF_CONDUCT.md>`_

How to contribute
************************

`CONTRIBUTING.md <https://rs-loy-gitlab.concordia.ca/Guille/hub/-/blob/master/CONTRIBUTING.md>`_

Coding style
************************

`PYGUIDE.md <https://rs-loy-gitlab.concordia.ca/Guille/hub/-/blob/master/PYGUIDE.md>`_

.. raw:: latex

   \tiny