Welcome to the DT4Safeguards documentation!
=======================================


.. toctree::
   :maxdepth: 2
   :caption: Contents:


Indices and tables
==================

* :ref:`genindex`

Introduction
------------
DT4Safeguards (Digital Twin for Safeguards in Nuclear Waste Management) is a python framework modeling safeguards activities in nuclear facilities related to the process of the disposal of nuclear waste.

The project can be found in the following repository:
https://jugit.fz-juelich.de/m.kreutle/DT4Safeguards

Requirements
------------
Make sure you have all required packages installed:

`pip install .`

For the full development setup including docs and test dependencies run:

`pip install .[docs,test]`

Results
-------
The results were visualized with Dash and can be displayed locally. Run the Dash app via:

`python3 project/app.py`

Results are then visible with a browser at http://127.0.0.1:8050/.


Classes and methods
-------------------

.. autoclass:: project.model.database.DatabaseSetup
    :members:
    :undoc-members:

.. autoclass:: project.model.database.DatabaseWrite
    :members:
    :undoc-members:

.. autoclass:: project.model.database.DatabaseRead
    :members:
    :undoc-members:

.. autoclass:: project.model.commander.PathFinder
    :members:
    :undoc-members:
    :private-members:
    :special-members:  __init__
    :autosummary:

.. autoclass:: project.model.commander.TransportCommander
    :members:
    :undoc-members:
    :private-members:
    :special-members:  __init__

.. autoclass:: tests.test_commander.TestTransportCommander
    :members:

.. autoclass:: project.model.commander.MonitoringSystem
    :members:
    :undoc-members:
    :private-members:

Impressum
---------

| Verantwortliche nach § 18, Abs. 2, Medienstaatsvertrag (MStV):
|
| Manuel Kreutle
|
| Institute of Fusion Energy and Nuclear Waste Management (IFN)
| IFN-2: Nuclear Waste Management
| Nuclear Safeguards and Security
|
| Forschungszentrum Jülich
| Wilhelm-Johnen-Straße
| 52428 Jülich
|
| Phone:  +49 2461 61-5829
| Email:  m.kreutle@fz-juelich.de