Skip to content

Commit

Permalink
omnibus-2024-05-13 (ufs-community#486)
Browse files Browse the repository at this point in the history
  • Loading branch information
@maddenp-noaa
maddenp-noaa authored May 14, 2024
1 parent bd0a418 commit fcfe2ab
Show file tree
Hide file tree
Showing 41 changed files with 224 additions and 428 deletions.
15 changes: 6 additions & 9 deletions docs/sections/user_guide/yaml/components/fv3.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,20 +50,17 @@ lateral_boundary_conditions:

Describes how the lateral boundary conditions have been prepared for a limited-area configuration of the FV3 forecast. Required when ``domain`` is ``regional``.

interval_hours:
"""""""""""""""
**interval_hours:**

How frequently the lateral boundary conditions will be used in the FV3 forecast, in integer hours.
How frequently the lateral boundary conditions will be used in the FV3 forecast, in integer hours.

offset:
"""""""
**offset:**

How many hours earlier the external model used for boundary conditions started compared to the desired forecast cycle, in integer hours.
How many hours earlier the external model used for boundary conditions started compared to the desired forecast cycle, in integer hours.

path:
"""""
**path:**

An absolute-path template to the lateral boundary condition files prepared for the forecast. The Python ``int`` variable ``forecast_hour`` will be interpolated into, e.g., ``/path/to/srw.t00z.gfs_bndy.tile7.f{forecast_hour:03d}.nc``. Note that this is a Python string template rather than a Jinja2 template.
An absolute-path template to the lateral boundary condition files prepared for the forecast. The Python ``int`` variable ``forecast_hour`` will be interpolated into, e.g., ``/path/to/srw.t00z.gfs_bndy.tile7.f{forecast_hour:03d}.nc``. Note that this is a Python string template rather than a Jinja2 template.

length:
^^^^^^^
Expand Down
226 changes: 95 additions & 131 deletions docs/sections/user_guide/yaml/components/make_hgrid.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,210 +26,174 @@ config:

Describes the required parameters to run a ``make_hgrid`` configuration.

grid_type:
""""""""""
**grid_type:**

``grid_type`` is the primary required key that defines the grid and additional required keys. It is specified with one of the following recognized key words:
``grid_type`` is the primary required key that defines the grid and additional required keys. It is specified with one of the following recognized key words:

.. list-table:: Grid Types and Requirements
:widths: 20 80
:header-rows: 1
.. list-table:: Grid Types and Requirements
:widths: 20 80
:header-rows: 1

* - Grid Type
- Requirements
* - ``beta_plane_grid``
- For setting geometric factors according to beta plane. ``f_plane_latitude`` needs to be specified.
* - ``conformal_cubic_grid``
- ``nratio`` is an optional argument.
* - ``f_plane_grid``
- For setting geometric factors according to f-plane. ``f_plane_latitude`` must be specified.
* - ``from_file``
- ``my_grid_file`` must be specified.
* - ``gnomonic_ed``
- Equal distance gnomonic cubic grid.
* - ``simple_cartesian_grid``
- ``xbnds``, ``ybnds`` must be specified to define the grid bounds location and grid size. ``simple_dx`` and ``simple_dy`` must be specified to specify uniform cell length.
* - ``spectral_grid``
- No other optional or required arguments.
* - ``regular_lonlat_grid``
- ``nxbnds``, ``nybnds``, ``xbnds``, ``ybnds`` must be specified to define the grid bounds.
* - ``tripolar_grid``
- ``nxbnds``, ``nybnds``, ``xbnds``, ``ybnds`` must be specified to define the grid bounds.
* - Grid Type
- Requirements
* - ``beta_plane_grid``
- For setting geometric factors according to beta plane. ``f_plane_latitude`` needs to be specified.
* - ``conformal_cubic_grid``
- ``nratio`` is an optional argument.
* - ``f_plane_grid``
- For setting geometric factors according to f-plane. ``f_plane_latitude`` must be specified.
* - ``from_file``
- ``my_grid_file`` must be specified.
* - ``gnomonic_ed``
- Equal distance gnomonic cubic grid.
* - ``simple_cartesian_grid``
- ``xbnds``, ``ybnds`` must be specified to define the grid bounds location and grid size. ``simple_dx`` and ``simple_dy`` must be specified to specify uniform cell length.
* - ``spectral_grid``
- No other optional or required arguments.
* - ``regular_lonlat_grid``
- ``nxbnds``, ``nybnds``, ``xbnds``, ``ybnds`` must be specified to define the grid bounds.
* - ``tripolar_grid``
- ``nxbnds``, ``nybnds``, ``xbnds``, ``ybnds`` must be specified to define the grid bounds.

angular_midpoint:
"""""""""""""""""
**angular_midpoint:**

If specified, when ``grid_type`` is ``from_file`` and the input is a NetCDF file, then the supergrid face midpoint coordinates are simply and independently (the lat independently from the lon) calculated as simple angular midpoints from the model grid coordinates.
If specified, when ``grid_type`` is ``from_file`` and the input is a NetCDF file, then the supergrid face midpoint coordinates are simply and independently (the lat independently from the lon) calculated as simple angular midpoints from the model grid coordinates.

center:
"""""""
**center:**

Specify the center location of grid.
Specify the center location of grid.

do_cube_transform:
""""""""""""""""""
**do_cube_transform:**

Set to re-orient the rotated cubed sphere so that tile 6 has 'north' facing upward. When ``do_cube_transform`` is set, the following must be set: ``stretch_factor``, ``latget_lon``, and ``target_lat``.
Set to re-orient the rotated cubed sphere so that tile 6 has 'north' facing upward. When ``do_cube_transform`` is set, the following must be set: ``stretch_factor``, ``latget_lon``, and ``target_lat``.

do_schmidt:
"""""""""""
**do_schmidt:**

Set to do Schmidt transformation to create a stretched grid. When ``do_schmidt`` is set, the following must be set: ``stretch_factor``, ``target_lon`` and ``target_lat``.
Set to do Schmidt transformation to create a stretched grid. When ``do_schmidt`` is set, the following must be set: ``stretch_factor``, ``target_lon`` and ``target_lat``.

dlat:
"""""
**dlat:**

Nominal resolution of meridional regions.
Nominal resolution of meridional regions.

dlon:
"""""
**dlon:**

Nominal resolution of zonal regions.
Nominal resolution of zonal regions.

great_circle_algorithm:
"""""""""""""""""""""""
**great_circle_algorithm:**

When specified, great_circle_algorithm will be used to compute grid cell area.
When specified, great_circle_algorithm will be used to compute grid cell area.

grid_name:
""""""""""
**grid_name:**

Specify the grid name.
Specify the grid name.

halo:
"""""
**halo:**

Halo size is to make sure the nest, including the halo region, is fully contained within a single parent (coarse) tile. It only needs to be specified when ``nest_grids`` is set.
Halo size is to make sure the nest, including the halo region, is fully contained within a single parent (coarse) tile. It only needs to be specified when ``nest_grids`` is set.

lat_join:
"""""""""
**lat_join:**

Specify latitude for joining spherical and rotated bipolar grid. Default value is 65 degrees.
Specify latitude for joining spherical and rotated bipolar grid. Default value is 65 degrees.

my_grid_file:
"""""""""""""
**my_grid_file:**

Read grid information from 'my_grid_file'. The file format can be ascii file or netcdf file. Required when ``grid_type`` is ``from_file``.
Read grid information from 'my_grid_file'. The file format can be ascii file or netcdf file. Required when ``grid_type`` is ``from_file``.

nest_grids:
"""""""""""
**nest_grids:**

Set to create this # nested grids as well as the global grid. This option could only be set when ``grid_type`` is ``gnomonic_ed``.
Set to create this # nested grids as well as the global grid. This option could only be set when ``grid_type`` is ``gnomonic_ed``.

istart_nest:
""""""""""""
**istart_nest:**

Specify the list of starting i-direction index(es) of nest grid(s) in parent tile supergrid(Fortran index).
Specify the list of starting i-direction index(es) of nest grid(s) in parent tile supergrid(Fortran index).

iend_nest:
""""""""""
**iend_nest:**

Specify the list of ending i-direction index(es) of nest grids in parent tile supergrid(Fortran index).
Specify the list of ending i-direction index(es) of nest grids in parent tile supergrid(Fortran index).

jstart_nest:
""""""""""""
**jstart_nest:**

Specify the list of starting j-direction index(es) of nest grids in parent tile supergrid(Fortran index).
Specify the list of starting j-direction index(es) of nest grids in parent tile supergrid(Fortran index).

jend_nest:
""""""""""
**jend_nest:**

Specify the list of ending j-direction index(es) of nest grids in parent tile supergrid(Fortran index).
Specify the list of ending j-direction index(es) of nest grids in parent tile supergrid(Fortran index).

non_length_angle:
"""""""""""""""""
**non_length_angle:**

When specified, will not output length(dx,dy) and angle (angle_dx, angle_dy).
When specified, will not output length(dx,dy) and angle (angle_dx, angle_dy).

nlat:
"""""
**nlat:**

Number of model grid points(supergrid) for each meridinal regions of varying resolution.
Number of model grid points(supergrid) for each meridinal regions of varying resolution.

nlon:
"""""
**nlon:**

Number of model grid points(supergrid) for each zonal regions of varying resolution.
Number of model grid points(supergrid) for each zonal regions of varying resolution.

nxbnds:
"""""""
**nxbnds:**

Specify number of zonal regions for varying resolution.
Specify number of zonal regions for varying resolution.

nybnds:
"""""""
**nybnds:**

Specify number of meridinal regions for varying resolution.
Specify number of meridinal regions for varying resolution.

nratio:
"""""""
**nratio:**

Specify the refinement ratio when calculating cell length and area of supergrid.
Specify the refinement ratio when calculating cell length and area of supergrid.

out_halo:
"""""""""
**out_halo:**

Extra halo size data to be written out. This is only works for ``gnomonic_ed``.
Extra halo size data to be written out. This is only works for ``gnomonic_ed``.

parent_tile:
""""""""""""
**parent_tile:**

Specify the list of the parent tile number(s) of nest grid(s).
Specify the list of the parent tile number(s) of nest grid(s).

refine_ratio:
"""""""""""""
**refine_ratio:**

Specify the list of refinement ratio(s) for nest grid(s).
Specify the list of refinement ratio(s) for nest grid(s).

rotate_poly:
""""""""""""
**rotate_poly:**

Set to calculate polar polygon areas by calculating the area of a copy of the polygon, with the copy being rotated far away from the pole.
Set to calculate polar polygon areas by calculating the area of a copy of the polygon, with the copy being rotated far away from the pole.

shift_fac:
""""""""""
**shift_fac:**

Shift west by 180/shift_fac. Default value is 18.
Shift west by 180/shift_fac. Default value is 18.

simple_dx:
""""""""""
**simple_dx:**

Specify the uniform cell length in x-direction for simple cartesian grid.
Specify the uniform cell length in x-direction for simple cartesian grid.

simple_dy:
""""""""""
**simple_dy:**

Specify the uniform cell length in y-direction for simple cartesian grid.
Specify the uniform cell length in y-direction for simple cartesian grid.

stretch_factor:
"""""""""""""""
**stretch_factor:**

Stretching factor for the grid.
Stretching factor for the grid.

target_lat:
"""""""""""
**target_lat:**

Center latitude of the highest resolution tile.
Center latitude of the highest resolution tile.

target_lon:
"""""""""""
**target_lon:**

Center longitude of the highest resolution tile.
Center longitude of the highest resolution tile.

verbose:
""""""""
**verbose:**

Will print out running time message when this is set. Otherwise the run will be silent when there is no error.
Will print out running time message when this is set. Otherwise the run will be silent when there is no error.

xbnds:
""""""
**xbnds:**

Specify boundaries for defining zonal regions of varying resolution. When ``tripolar`` is present, also defines the longitude of the two new poles.
Specify boundaries for defining zonal regions of varying resolution. When ``tripolar`` is present, also defines the longitude of the two new poles.

ybnds:
""""""
**ybnds:**

Specify boundaries for defining meridional regions of varying resolution.
Specify boundaries for defining meridional regions of varying resolution.

run_dir:
^^^^^^^^
Expand Down
30 changes: 12 additions & 18 deletions docs/sections/user_guide/yaml/components/make_solo_mosaic.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,35 +20,29 @@ config:

Describes the required parameters to run a ``make_solo_mosaic`` configuration.

dir:
""""
**dir:**

The path to the directory that contains the tile grid files.
The path to the directory that contains the tile grid files.

mosaic_name:
""""""""""""
**mosaic_name:**

The optional name of the output file.
The optional name of the output file.

num_tiles:
""""""""""
**num_tiles:**

Number of tiles in the mosaic.
Number of tiles in the mosaic.

periodx:
""""""""
**periodx:**

The period in the x-direction of the mosaic.
The period in the x-direction of the mosaic.

periody:
""""""""
**periody:**

The period in the y-direction of the mosaic.
The period in the y-direction of the mosaic.

tile_file:
""""""""""
**tile_file:**

The grid file name of all of the tiles in the mosaic.
The grid file name of all of the tiles in the mosaic.

execution:
^^^^^^^^^^
Expand Down
Loading

0 comments on commit fcfe2ab

Please sign in to comment.