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.

Sign up for GitHub

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

Corrects example of a CLI in the Read the Doc documentation #1673

Merged
merged 5 commits into from
Feb 21, 2022
Merged

Corrects example of a CLI in the Read the Doc documentation #1673

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
894b76b
Update to the Example use of a CLI on ReadtheDocs
mspelman07 Feb 15, 2022
f77c890
Adding name to Contributing file
mspelman07 Feb 15, 2022
00c4cd8
Updates to CLI Example in Read the Docs
mspelman07 Feb 17, 2022
c5da09a
Updates to CLI example
mspelman07 Feb 21, 2022
93aca96
Updates to CLI example
mspelman07 Feb 21, 2022
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
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ below:
* Caroline Sandford (Met Office, UK)
* Victoria Smart (Met Office, UK)
* Eleanor Smith (Met Office, UK)
* Marcus Spelman (Met Office, UK)
* Belinda Trotta (Bureau of Meteorology, Australia)
* Tomasz Trzeciak (Met Office, UK)
* Mark Worsfold (Met Office, UK)
Expand Down
11 changes: 6 additions & 5 deletions doc/source/about.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,15 @@ Here we give a simple example of using an IMPROVER CLI to threshold data, moving

.. code:: console

bin/improver threshold input_file.nc output_file.nc 5 10 15 20 --threshold_units m/s
bin/improver threshold input.nc --threshold-values 5,10,15,20 --threshold-units m/s --output output.nc


* input_file.nc is a netCDF file containing a forecast diagnostic data cube, e.g. wind speeds across an x-y grid at a given time.
* threshold is the name of file to be called. In cases where the name has under-scores these should be written as hyphens e.g. snow_fraction would be written as snow-fraction.
mspelman07 marked this conversation as resolved.
Show resolved Hide resolved
* input.nc is a netCDF file containing a forecast diagnostic data cube, e.g. wind speeds across an x-y grid at a given time.
* for each threshold specified (5, 10, 15, 20 m/s) a new x-y grid of data will be created. Each point in the grid will contain a 0 if the input wind speed at that point was below the threshold, or 1 if it was above the threshold.
* output_file.nc will be a new netCDF file containing the resulting data cube with an additional leading dimension that corresponds to the given thresholds (5, 10, 15, 20 m/s).
* the threshold units specifies the units of the provided thresholds (m/s) and these will be converted to match the units of the original cube before thresholding the input cube.
* output.nc will be a new netCDF file containing the resulting data cube with an additional leading dimension that corresponds to the given thresholds (5, 10, 15, 20 m/s).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed when I built the docs that the --help part of this line renders a bit odd. I think it only needs one \ rather than \. Could you fix that too?

This simple example covers one step in a processing chain. Additional information about using any CLI can be found on the command line using `\\-\\-help` (or `-h`), e.g.:
This simple example covers one step in a processing chain. Additional information about using any CLI can be found on the command line using `\-\-help` (or `-h`), e.g.:

.. code:: console

Expand Down