Skip to content
Merged
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
11 changes: 11 additions & 0 deletions docs/sphinx/atbd.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. atbd - algorithm theoretical basis
Author: seh2
Email: sam.hunt@npl.co.uk
Created: 23/3/20

.. _atbd:

Algorithm Theoretical Basis
===========================

.. include:: content/atbd/atbd.rst
8 changes: 6 additions & 2 deletions docs/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ def setup(app):

# The master toctree document.
master_doc = 'index'
atbd = 'atbd'
userguide = 'userguide'

# General information about the project.
project = u'hypernets_processor'
Expand Down Expand Up @@ -295,7 +297,9 @@ def setup(app):
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'hypernets_processor.tex', u'Hypernets Processor Documentation',
(userguide, 'hypernets_processor_userguide.tex', u'Hypernets Processor User Guide',
u'Hypernets Project Team', 'manual'),
(atbd, 'hypernets_processor_atbd.tex', u'Hypernets Processor Algorithm Theoretical Basis Document',
u'Hypernets Project Team', 'manual'),
]

Expand Down Expand Up @@ -352,7 +356,7 @@ def setup(app):
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'hypernets_processor', u'hypernets_processor Documentation',
(master_doc, 'hypernets_processor', u'Hypernets Processor User Guide',
author, 'hypernets_processor', 'One line description of project.',
'Miscellaneous'),
]
Expand Down
7 changes: 4 additions & 3 deletions docs/sphinx/content/atbd/atbd.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
.. atbd - algorithm theoretical basis
Author: seh2
Email: sam.hunt@npl.co.uk
Created: 23/3/20
Created: 6/11/20

.. _atbd:


Algorithm Theoretical Basis
===========================
~~~~~~~~~~~~~~~~~~~~~~~~~~~

For more information see the project document.
TBC
15 changes: 0 additions & 15 deletions docs/sphinx/content/developers/developers.rst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

.. _user_adhoc:

User Guide - Ad-hoc Sequence Processing
=======================================
Ad-hoc Sequence Processing
==========================

This section provides a user guide for running the **hypernets_processor** module to process specified field acquisitions, or sequences, on an ad-hoc basis outside of any automated processing.

Expand Down Expand Up @@ -43,7 +43,7 @@ where:

* `input_directory` - directory of raw sequence product, or directory containing a number of raw sequence products, to process.
* `output_directory` - directory to write output data to.
* `network` - network name, land or water. The default configuration for this network is applied for the processing.
* `network` - network name, `land` or `water`. The default configuration for this network is applied for the processing.

To see more options, try::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

.. _user_automated:

User Guide - Automated Processing
=================================
Automated Processing
====================

This section provides a user guide for running the **hypernets_processor** module as an automated processor of incoming field data. In this scenario, a set of field hypstar systems are regularly syncing raw data to a server. Running on this server, the **hypernets_processor** processes the data and adds it to an archive that can be accessed through a user portal.

Expand Down
36 changes: 16 additions & 20 deletions docs/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,32 @@ hypernets_processor: Hypernets field and land network data processor

The **hypernets_processor** module is a Python software package to process the `Hypernets <http://hypernets.eu/from_cms/summary>`_ land and water network in-situ hyperspectral data to surface reflectance products for distribution to users.

There are two main use cases for the **hypernets_processor** module. The primary function of the software is the automated preparation of data retrieved from network sites for distribution to users. Additionally, the software may also be used for ad-hoc processing of particular field acquisitions, for example for testing instrument operation in the field.

This documentation aimed at both users and developers of the software, find the relevant sections below.

For Users:
~~~~~~~~~~
.. toctree::
:maxdepth: 1
:caption: User Guide

content/users/adhoc
content/users/automated

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: ATBD

content/users/users
content/atbd/atbd

For Developers:
~~~~~~~~~~~~~~~

.. toctree::
:maxdepth: 2

content/developers/developers
:maxdepth: 1
:caption: Developer Guide

API Documentation
~~~~~~~~~~~~~~~~~
content/developers/getting_started
content/developers/software_design

.. toctree::
:maxdepth: 2
:caption: API Documentation

content/API/hypernets_processor

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

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
content/API/hypernets_processor
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ There are two main use cases for the **hypernets_processor** module. The primary
.. toctree::
:maxdepth: 1

user_adhoc
user_automated
content/users/adhoc
content/users/automated