185 lines
4.1 KiB
ReStructuredText
185 lines
4.1 KiB
ReStructuredText
.. _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
|
|
*************************
|
|
|
|
* Guillermo Gutierrez Morote
|
|
* Pilar Monsalvete Alvarez de Uribarri
|
|
|
|
Contributors
|
|
*************************
|
|
|
|
* Seyedehrabeeh Hosseinihaghighi
|
|
* Milad Aghamohamadnia
|
|
* Peter Yefi
|
|
* Koa Wells
|
|
* Sanam Dabirian
|
|
* Soroush Samareh Abolhassani
|
|
|
|
About the PERSISTENCE
|
|
*************************
|
|
|
|
This document contains the essential documentation for the CERC PERSISTENCE, a set of classes, factories, and helpers that simplifies the research at urban scale in multiples domains; these components are designed around three central axes, **extensibility**, **code clarity** and **consistency** as we intend to allow domain experts to perform urban scale simulations with multiple programs and enrich the city from several data sources.
|
|
PERSISTENCE is composed of four main components: **repositories** and **models**.
|
|
|
|
Folder structure
|
|
******************
|
|
|
|
.. image:: ./cerc_persistence.png
|
|
:width: 200
|
|
|
|
Model Classes
|
|
****************************
|
|
|
|
Application
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.application.Application
|
|
:members:
|
|
:private-members:
|
|
|
|
City
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.city.City
|
|
:members:
|
|
:private-members:
|
|
|
|
CityObject
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.city_object.CityObject
|
|
:members:
|
|
:private-members:
|
|
|
|
|
|
SimulationResults
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.simulation_results.SimulationResults
|
|
:members:
|
|
:private-members:
|
|
|
|
|
|
User
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.user.User
|
|
:members:
|
|
:private-members:
|
|
|
|
|
|
UserRoles
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.user.UserRoles
|
|
:members:
|
|
:private-members:
|
|
|
|
Repository Classes
|
|
****************************
|
|
|
|
Application
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.application.Application
|
|
:members:
|
|
:private-members:
|
|
|
|
City
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.city.City
|
|
:members:
|
|
:private-members:
|
|
|
|
CityObject
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.city_object.CityObject
|
|
:members:
|
|
:private-members:
|
|
|
|
|
|
SimulationResults
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.simulation_results.SimulationResults
|
|
:members:
|
|
:private-members:
|
|
|
|
|
|
User
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.models.user.User
|
|
:members:
|
|
:private-members:
|
|
|
|
Classes
|
|
****************************
|
|
|
|
Configuration
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.configuration.Configuration
|
|
:members:
|
|
:private-members:
|
|
|
|
DB Control
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.db_control.DBControl
|
|
:members:
|
|
:private-members:
|
|
|
|
DB Setup
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.db_setup.DBSetup
|
|
:members:
|
|
:private-members:
|
|
|
|
Repository
|
|
^^^^^^^^^^^^^^^^^^^^^^
|
|
.. autocercclass:: cerc_persistence.repository.Repository
|
|
:members:
|
|
:private-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 |