cerc_persistence_doc/source/index.rst

.. _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
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`.. _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`

Replaced hub in multiple places 2023-11-28 14:27:42 -05:00			`CERC PERSISTENCE' reference manual`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`=====================================`
			`.. toctree::`
			`:maxdepth: 4`
			`:caption: Contents:`

Replaced hub in multiple places 2023-11-28 14:27:42 -05:00			`CERC PERSISTENCE' reference manual`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`=====================================`
			`Authors`
			`*************************`

correct cerc_persistence autodoc 2024-04-02 02:22:36 -04:00			`* Peter Yefi`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`* Guillermo Gutierrez Morote`

			`Contributors`
			`*************************`

correct cerc_persistence autodoc 2024-04-02 02:22:36 -04:00			`* Ruben Sanchez`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00
Replaced hub in multiple places 2023-11-28 14:27:42 -05:00			`About the PERSISTENCE`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`*************************`

correct cerc_persistence autodoc 2024-04-02 02:22:36 -04:00			`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.`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00
			`Folder structure`
			`******************`

Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`.. image:: ./cerc_persistence.png`
correct cerc_persistence autodoc 2024-04-02 02:22:36 -04:00			`:width: 400`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00
Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`Model Classes`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`****************************`

Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`Application`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`^^^^^^^^^^^^^^^^^^^^^^`
Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`.. autocercclass:: cerc_persistence.models.application.Application`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`

Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`City`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`^^^^^^^^^^^^^^^^^^^^^^`
Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`.. autocercclass:: cerc_persistence.models.city.City`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`

Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`CityObject`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`^^^^^^^^^^^^^^^^^^^^^^`
Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`.. autocercclass:: cerc_persistence.models.city_object.CityObject`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`


Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`SimulationResults`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`^^^^^^^^^^^^^^^^^^^^^^`
Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`.. autocercclass:: cerc_persistence.models.simulation_results.SimulationResults`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`


Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`User`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`^^^^^^^^^^^^^^^^^^^^^^`
Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`.. autocercclass:: cerc_persistence.models.user.User`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`


Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`Repository Classes`
			`****************************`

			`Application`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`^^^^^^^^^^^^^^^^^^^^^^`
correct cerc_persistence autodoc 2024-04-02 02:22:36 -04:00			`.. autocercclass:: cerc_persistence.repositories.application.Application`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`

Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`City`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`^^^^^^^^^^^^^^^^^^^^^^`
correct cerc_persistence autodoc 2024-04-02 02:22:36 -04:00			`.. autocercclass:: cerc_persistence.repositories.city.City`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`

Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`CityObject`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`^^^^^^^^^^^^^^^^^^^^^^`
correct cerc_persistence autodoc 2024-04-02 02:22:36 -04:00			`.. autocercclass:: cerc_persistence.repositories.city_object.CityObject`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`


Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`SimulationResults`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`^^^^^^^^^^^^^^^^^^^^^^`
correct cerc_persistence autodoc 2024-04-02 02:22:36 -04:00			`.. autocercclass:: cerc_persistence.repositories.simulation_results.SimulationResults`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`


Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`User`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`^^^^^^^^^^^^^^^^^^^^^^`
correct cerc_persistence autodoc 2024-04-02 02:22:36 -04:00			`.. autocercclass:: cerc_persistence.repositories.user.User`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`

Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`Classes`
			`****************************`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00
Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`Configuration`
			`^^^^^^^^^^^^^^^^^^^^^^`
			`.. autocercclass:: cerc_persistence.configuration.Configuration`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`

Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`DB Control`
			`^^^^^^^^^^^^^^^^^^^^^^`
			`.. autocercclass:: cerc_persistence.db_control.DBControl`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`

Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`DB Setup`
			`^^^^^^^^^^^^^^^^^^^^^^`
			`.. autocercclass:: cerc_persistence.db_setup.DBSetup`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`:members:`

Update index.rst to reflect persistence repo 2023-11-29 13:04:46 -05:00			`Repository`
			`^^^^^^^^^^^^^^^^^^^^^^`
			`.. autocercclass:: cerc_persistence.repository.Repository`
Copy from hub docs modified to fit the persistence repo 2023-11-28 13:36:40 -05:00			`: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`