From a693dce58624caf5df4785e08cd41dee3d1586ef Mon Sep 17 00:00:00 2001 From: dwest77a Date: Wed, 8 Jan 2025 11:05:53 +0000 Subject: [PATCH] Updated documentation --- docs/source/index.rst | 1 + docs/source/phase_source.rst | 35 +++++++++++++++++++++++++++++++++++ docs/source/phases.rst | 9 --------- 3 files changed, 36 insertions(+), 9 deletions(-) create mode 100644 docs/source/phase_source.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index f384603..48e64ba 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -56,6 +56,7 @@ The ingestion/cataloging phase is not currently implemented for public use but m Projects Groups + Phases Filehandlers, Logs, and Utilities Indices and Tables diff --git a/docs/source/phase_source.rst b/docs/source/phase_source.rst new file mode 100644 index 0000000..e77afb5 --- /dev/null +++ b/docs/source/phase_source.rst @@ -0,0 +1,35 @@ +================ +Phased Operators +================ + +Scan Operations +--------------- + +.. automodule:: padocc.phases.scan + :members: + :show-inheritance: + +Compute Operations +--------------- + +.. automodule:: padocc.phases.compute + :members: + :show-inheritance: + +Validate Operations +--------------- + +.. automodule:: padocc.phases.validate + :members: + :show-inheritance: + +Ingest Operations +--------------- + +.. note:: + + Not featured in this development, the ingest operations are still being planned and scoped. + +.. automodule:: padocc.phases.ingest + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/phases.rst b/docs/source/phases.rst index d165111..12c5ba2 100644 --- a/docs/source/phases.rst +++ b/docs/source/phases.rst @@ -40,8 +40,6 @@ The scan phase can be activated with the following: mygroup.run('scan',mode='kerchunk') -.. automodule:: padocc.phases.scan - :members: Compute ------- @@ -74,10 +72,6 @@ Computation can be executed in serial for a group with the following: mygroup.run('compute',mode='kerchunk') -.. automodule:: padocc.phases.compute - :members: - :show-inheritance: - Validate -------- @@ -108,9 +102,6 @@ validator which checks the Xarray representations and identifies differences in # The validation reports will be saved to the filesystem for each project in this group # as 'data_report.json' and 'metadata_report.json' -.. automodule:: padocc.phases.validate - :members: - Next Steps ----------