Skip to content

Commit

Permalink
rtd doc bayesian_ar_detect app command line opts
Browse files Browse the repository at this point in the history
  • Loading branch information
burlen committed Apr 12, 2021
1 parent ece30f1 commit eed608a
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions doc/rtd/applications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1004,6 +1004,19 @@ Command Line Arguments
--write_ivt
when this flag is present IVT vector is written to disk with the result

--dem arg
A teca_cf_reader regex identifying the file containing surface elevation field or DEM.

--dem_variable arg (=Z)
Sets the name of the variable containing the surface elevation field

--mesh_height arg (=Zg)
Sets the name of the variable containing the point wise vertical height in meters above mean
sea level

--ar_probability arg (=ar_probability)
Sets the name of the variable to store the computed AR probability mask in.

--ar_weighted_variables arg
An optional list of variables to weight with the computed AR probability. Each such variable
will be multiplied by the computed AR probability, and written to disk as "NAME_ar_wgtd".
Expand All @@ -1020,17 +1033,29 @@ Command Line Arguments
--periodic_in_x arg (=1)
Flags whether the x dimension (typically longitude) is periodic.

--binary_ar_threshold arg (=0.667)
probability threshold for segmenting ar_probability to produce ar_binary_tag
--segment_ar_probability
A flag that enables a binary segmentation of AR probability to be produced. `--segment_threshold`
controls the segmentation. threshold and `--segment_variable` to set the name of the variable to
store the result in.

--segment_threshold arg (=0.667)
Sets the threshold value that is used when segmenting ar_probability. See also
`--segment_ar_probability`

--output_file arg (=CASCADE_BARD_%t%.nc)
--segment_variable arg (=ar_binary_tag)
Set the name of the variable to store the result of a binary segmentation of AR probabilty. See
also `--segment_ar_probability`.

--output_file arg (=TECA_BARD_%t%.nc)
A path and file name pattern for the output NetCDF files. %t% is replaced with a human readable
date and time corresponding to the time of the first time step in the file. Use
`--cf_writer::date_format` to change the formatting

--steps_per_file arg (=128)
number of time steps per output file

--first_step arg (=0)
first time step to process

--last_step arg (=-1)
last time step to process
Expand Down

0 comments on commit eed608a

Please sign in to comment.