2020-07-06 17:28:59 +02:00
|
|
|
***********************
|
2020-05-25 17:00:28 +02:00
|
|
|
Developer Documentation
|
2020-07-06 17:28:59 +02:00
|
|
|
***********************
|
|
|
|
|
|
|
|
|
|
The following section provides detailed information on the the software architecture and on the possibilities to extend ESBO-ETC.
|
|
|
|
|
The source code of ESBO-ETC and this documentation can be found on the `IRS Gitea-server <https://egit.irs.uni-stuttgart.de/esbo_ds/ESBO-ETC>`_.
|
|
|
|
|
|
|
|
|
|
.. note::
|
2020-07-07 14:56:47 +02:00
|
|
|
In the following, methods of the source code may be mentioned without any details on the required parameters or the return values.
|
|
|
|
|
Please refer to the :ref:`api` for further information.
|
|
|
|
|
|
|
|
|
|
ESBO-ETC uses `Astropy Quantities <https://docs.astropy.org/en/stable/units/>`_ for all computations in order to ensure proper unit conversion.
|
2020-05-25 17:00:28 +02:00
|
|
|
|
|
|
|
|
Project Structure
|
2020-07-06 17:28:59 +02:00
|
|
|
=================
|
|
|
|
|
|
2020-07-07 14:56:47 +02:00
|
|
|
.. include:: project_structure.rst
|
2020-07-06 17:28:59 +02:00
|
|
|
|
2020-09-09 17:39:40 +02:00
|
|
|
ESBO-ETC Python module
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
.. include:: scripting.rst
|
|
|
|
|
|
2020-07-06 17:28:59 +02:00
|
|
|
Software Architecture
|
|
|
|
|
=====================
|
|
|
|
|
|
2020-07-07 14:56:47 +02:00
|
|
|
.. include:: software_architecture.rst
|
2020-07-06 17:28:59 +02:00
|
|
|
|
2020-07-07 14:56:47 +02:00
|
|
|
Other Classes
|
|
|
|
|
=============
|
2020-07-06 17:28:59 +02:00
|
|
|
|
2020-07-07 14:56:47 +02:00
|
|
|
.. include:: classes.rst
|
2020-05-25 17:00:28 +02:00
|
|
|
|
|
|
|
|
Extending ESBO-ETC
|
2020-07-06 17:28:59 +02:00
|
|
|
==================
|
|
|
|
|
|
2020-07-07 14:56:47 +02:00
|
|
|
.. include:: extending.rst
|
2020-08-24 15:47:20 +02:00
|
|
|
|
|
|
|
|
CI/CD-Pipeline
|
|
|
|
|
==============
|
|
|
|
|
|
|
|
|
|
.. include:: pipeline.rst
|
