Skip to content

Commit

Permalink
rtd doc integrated_vapor_transport app command line opts
Browse files Browse the repository at this point in the history
  • Loading branch information
burlen committed Apr 9, 2021
1 parent e4b7719 commit a129675
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions doc/rtd/applications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1221,8 +1221,14 @@ taken into account. See the :ref:`teca_metadata_probe` ARTMIP :ref:`example<mdp_

teca_integrated_vapor_transport
-------------------------------
The integrated vapor transport(IVT) command line application computes IVT from
input wind vector and specific humidity.
The integrated vapor transport(IVT) command line application computes:

.. math::
IVT = \frac{1}{g} \int_{p_{sfc}}^{p_{top}} \vec{v} q dp
where q is the specific humidity, and :math:`\vec{v} = (u, v)` are the
longitudinal and latitudinal components of wind.

Inputs
~~~~~~
Expand Down Expand Up @@ -1267,7 +1273,7 @@ Command Line Arguments
name to use for the latitudinal component of the integrated vapor transport vector.

--ivt arg (=IVT)
name of variable with the magnitude of integrated vapor transport
name of variable with the magnitude of integrated vapor transport (IVT)

--write_ivt_magnitude arg (=0)
when this is set to 1 magnitude of vector IVT is calculated. use `--ivt_u` and `--ivt_v` to set the
Expand All @@ -1294,8 +1300,15 @@ Command Line Arguments
--z_axis_variable arg (=plev)
name of z coordinate variable

--periodic_in_x arg (=1)
Flags whether the x dimension (typically longitude) is periodic.
--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

--first_step arg (=0)
first time step to process
Expand All @@ -1310,8 +1323,8 @@ Command Line Arguments
--end_date arg
The last time to process in 'Y-M-D h:m:s' format

--n_threads arg
Sets the thread pool size on each MPI rank. When the default value of -1 is used TECA will
--n_threads arg (=-1)
Sets the thread pool size on each MPI rank. When the default value of -1 is used TECA will
coordinate the thread pools across ranks such each thread is bound to a unique physical core.

--verbose
Expand Down

0 comments on commit a129675

Please sign in to comment.