Add draft of dima documentation

This commit is contained in:
2024-11-26 13:40:43 +01:00
parent 11ca454b94
commit f4f27b7084
88 changed files with 12382 additions and 0 deletions

26
docs/build/html/_sources/index.rst.txt vendored Normal file
View File

@ -0,0 +1,26 @@
.. DIMA documentation master file, created by
sphinx-quickstart on Wed Jul 10 15:50:06 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to DIMA's documentation!
================================
.. toctree::
:maxdepth: 2
:caption: Contents:
modules/src
modules/pipelines
modules/utils
modules/notebooks
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

View File

@ -0,0 +1,7 @@
Notebooks
==========================
.. automodule:: notebooks
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,12 @@
Pipelines and workflows
==========================
.. automodule:: pipelines.data_integration
:members:
:undoc-members:
:show-inheritance:
.. automodule:: pipelines.metadata_revision
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,27 @@
HDF5 Data Operations
==========================
.. automodule:: src.hdf5_ops
:members:
:undoc-members:
:show-inheritance:
HDF5 Writer
==========================
.. automodule:: src.hdf5_writer
:members:
:undoc-members:
:show-inheritance:
Data Visualization
==================
.. automodule:: src.hdf5_vis
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,7 @@
Data Structure Conversion
=========================
.. automodule:: utils.g5505_utils
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,7 @@
Tutorial workflows
==========================
.. automodule:: workflow_data_integration
:members:
:undoc-members:
:show-inheritance: