Skip to content

Commit

Permalink
Unrelated to #3037, update the Python embedding Appendix to list gen_…
Browse files Browse the repository at this point in the history
…ens_prod.
  • Loading branch information
JohnHalleyGotway committed Jan 24, 2025
1 parent bf40993 commit 5a1a0dc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/Users_Guide/appendixF.rst
Original file line number Diff line number Diff line change
Expand Up @@ -358,10 +358,10 @@ The first argument for the Plot-Data-Plane tool is the gridded data file to be r
'grid': { ... } }
DEBUG 1: Creating postscript file: fcst.ps
Special Case for Ensemble-Stat, Series-Analysis, and MTD
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Special Case for Gen-Ens-Prod, Ensemble-Stat, Series-Analysis, and MTD
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The Ensemble-Stat, Series-Analysis, MTD and Gen-Ens-Prod tools all have the ability to read multiple input files. Because of this feature, a different approach to Python embedding is required. A typical use of these tools is to provide a list of files on the command line. For example:
The Gen-Ens-Prod, Ensemble-Stat, Series-Analysis, and MTD tools all have the ability to read multiple input files. Because of this feature, a different approach to Python embedding is required. A typical use of these tools is to provide a list of files on the command line. For example:

.. code-block::
:caption: Gen-Ens-Prod Command Line
Expand All @@ -381,7 +381,7 @@ In the event the user requires command line arguments to their Python script, th
.. code-block::
:caption: Gen-Ens-Prod Command Line with Python Args
gen_ens_proce ens1.nc,arg1,arg2 ens2.nc,arg1,arg2 ens3.nc,arg1,arg2 ens4.nc,arg1,arg2 \
gen_ens_prod ens1.nc,arg1,arg2 ens2.nc,arg1,arg2 ens3.nc,arg1,arg2 ens4.nc,arg1,arg2 \
-out ens_prod.nc -config GenEnsProd_config
In this case, the user's Python script will receive "ens1.nc,arg1,arg2" as a single command line argument for each execution of the Python script (i.e. 1 time per file). The user must parse this argument inside their Python script to obtain **arg1** and **arg2** as separate arguments. The list of input files and optionally, any command line arguments can be written to a single file called **file_list** that is substituted for the file names and command line arguments. For example:
Expand Down

0 comments on commit 5a1a0dc

Please sign in to comment.