Skip to content

Commit

Permalink
Convert tables in setup.rst
Browse files Browse the repository at this point in the history
- Change table syntax to sphinx syntax.
- Remove extra line in index.rst.

Refs NOAA-EMC#1272
  • Loading branch information
KateFriedman-NOAA committed Jan 23, 2023
1 parent 5d39ba6 commit f1a048f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 26 deletions.
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Status
======

* State of develop (HEAD) branch: GFSv17+ development

* State of operations: GFS v16.3.5 `tag: [gfs.v16.3.5] <https://github.com/NOAA-EMC/global-workflow/releases/tag/gfs.v16.3.5>`_

=============
Expand Down
50 changes: 25 additions & 25 deletions docs/source/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,34 @@ Experiment Setup

Global workflow uses a set of scripts to help configure and set up the drivers (also referred to as Workflow Manager) that run the end-to-end system. While currently we use a `ROCOTO <https://github.com/christopherwharrop/rocoto/wiki/documentation>`__ based system and that is documented here, an `ecFlow <https://www.ecmwf.int/en/learning/training/introduction-ecmwf-job-scheduler-ecflow>`__ based systm is also under development and will be introduced to the Global Workflow when it is mature. To run the setup scripts, you need to make sure to have a copy of ``python3`` with ``numpy`` available. The easiest way to guarantee this is to load python from the `official hpc-stack installation <https://github.com/NOAA-EMC/hpc-stack/wiki/Official-Installations>`_ for the machine you are on:

+------------+----------------------------------------------------------+
| MACHINE | PYTHON MODULE LOAD COMMAND(S) |
+------------+----------------------------------------------------------+
| Hera | ``module use -a /contrib/anaconda/modulefiles`` |
| | ``module load anaconda/anaconda3-5.3.1`` |
+------------+----------------------------------------------------------+
| Orion | ``module load python/3.7.5`` |
+------------+----------------------------------------------------------+
| WCOSS2 | ``module load python/3.8.6`` |
+------------+----------------------------------------------------------+
| S4 | ``module load miniconda/3.8-s4`` |
+------------+----------------------------------------------------------+
.. list-table::
* - **MACHINE**
- **PYTHON MODULE LOAD COMMAND(S)**
* - Hera
- | ``module use -a /contrib/anaconda/modulefiles``
- | ``module load anaconda/anaconda3-5.3.1``
* - Orion
- ``module load python/3.7.5``
* - WCOSS2
- ``module load python/3.8.6``
* - S4
- ``module load miniconda/3.8-s4``

If running with Rocoto make sure to have a Rocoto module loaded before running setup scripts:

+------------+----------------------------------------------------------+
| MACHINE | ROCOTO MODULE LOAD COMMAND(S) |
+------------+----------------------------------------------------------+
| Hera | ``module load rocoto/1.3.3`` |
+------------+----------------------------------------------------------+
| Orion | ``module load contrib`` |
| | ``module load rocoto/1.3.3`` |
+------------+----------------------------------------------------------+
| WCOSS2 | ``module use /apps/ops/test/nco/modulefiles/`` |
| | ``module load core/rocoto/1.3.5`` |
+------------+----------------------------------------------------------+
| S4 | ``module load rocoto/1.3.4`` |
+------------+----------------------------------------------------------+
.. list-table::
* - **MACHINE**
- **ROCOTO MODULE LOAD COMMAND(S)**
* - Hera
- ``module load rocoto/1.3.3``
* - Orion
- | ``module load contrib``
- | ``module load rocoto/1.3.3``
* - WCOSS2
- | ``module use /apps/ops/test/nco/modulefiles/``
- | ``module load core/rocoto/1.3.5``
* - S4
- ``module load rocoto/1.3.4``

^^^^^^^^^^^^^^^^^^^^^^^^
Forecast-only experiment
Expand Down

0 comments on commit f1a048f

Please sign in to comment.