Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev #24

Merged
merged 2 commits into from
May 30, 2024
Merged

Dev #24

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/source/_images/esa.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import sys
sys.path.insert(0, os.path.abspath('../../'))

project = 'Padocc Package'
project = 'PADOCC Package'
copyright = '2024, Daniel Westwood'
author = 'Daniel Westwood'
release = 'v1.1'
Expand Down
21 changes: 15 additions & 6 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Padocc - User Documentation
PADOCC - User Documentation
============================

**padocc** (Pipeline to Aggregate Data for Optimised Cloud Capabilites) is a Python package (package name **kerchunk-builder**) for aggregating data to enable methods of access for cloud-based applications.
Expand All @@ -26,7 +26,7 @@ The pipeline consists of four central phases, with an additional phase for inges
:alt: Stages of the Kerchunk Pipeline

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

Introduction <pipeline-overview>
Expand All @@ -38,14 +38,14 @@ The pipeline consists of four central phases, with an additional phase for inges
Developer's Guide <dev-guide>

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: CLI Tool Source:

Assessor Source <assess>
Control Scripts Source <execution-source>

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Pipeline Source:

Initialisation <init>
Expand All @@ -55,11 +55,20 @@ The pipeline consists of four central phases, with an additional phase for inges
Allocations <allocation>
Utils <extras>



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

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Acknowledgements
================
PADOCC was developed at the Centre for Environmental Data Analysis, supported by the ESA CCI Knowledge Exchange program and contributing to the development of the Earth Observation Data Hub (EODH).

.. image:: _images/ceda.png
:alt: CEDA Logo

.. image:: _images/esa.png
:alt: ESA Logo
Loading