Enhanced High Resolution ATM (EHRATM) Documentation
Last update: 2024-04-18 00:45Z
Introduction
Sphinx Documentation
This is the top level page for the Enhanced High Resolution ATM (EHRATM) system. With four primary subsystems - nwpservice, ehratm, ehratmworkflow and nwpinstall, there is a separate Sphinx project for each, as well as one for this top-level documentation. Although the four subsystems are related, they have been built to be as standalone as possible, and therefore the documentation in each one is intended to be standalone.
Although Sphinx and gitlab very nicely support the viewing of a Sphinx project within the gitlab view, to the best of my knowledge it is not possible to do this with multiple Sphinx projects within a single repository. Therefore, the documentation for the project is maintained in the five different Sphinx projects, and a program to unify all of this into a single HTML directory hierarchy has been created and used to deploy the documentation locally and on remote web servers. Please refer to About the EHRATM Documentation for details and the relatively simple procedures for generating the full HTML directory tree.
The directory tree for the entire HTML contents that refer to this delivery have been placed on devlan in
/dvlscratch/ATM/morton/EHRATM-develop-freeze-v1.0/EHRATM_Docs-develop-freeze-v1.0-2023-11-26.tar.gz
Project Gitlab Repository
The gitlab repository for the project deliverables is located at https://gitlabx.ctbto.org/ctbtosa/high-res-atm. The deliverable repository contents are currently available on devlan in
/dvlscratch/ATM/morton/git/high-res-atm/
and its state has been recorded by the git tag
develop-freeze-v1.0-2023-11-26
Many of the examples within this documentation refer to that location. It was felt that initial users might want to start with an already-installed system for gaining initial familiarity without the complications of figuring out new paths, etc. for the examples.
The repository can easily be cloned, however, and setting to the delivery tag, develop-freeze-v1.0-2023-11-26, and various examples and demonstrations will need to account for the location changes.
Documentation Layout
The documentation here starts at the top level, describing the logistics of maintaining the documentation, an overview of the EHRATM project, a New User HOWTO, and an overview of system Installation. This is followed by links to the documentation for the four subsystems that serve as the foundation for the EHRATM system.
Subsystems
These are independent Sphinx projects within the repository, linked to from this document. Reverse links are not currently supported (once you go into one of these, you can only get back here with the “back” key, or the original URL). Although it would be possible to set up links from these projects back to this document, it would destroy the independent, standalone nature of the subsystems, and would also be very difficult to do in a way that would keep the HTML tree portable on different web servers. So, for now it stays this way.