Creating MITGCM Boundary conditions¶

mkMITgcmBC¶

Usage:

mkMITgcmBC [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

• igrid: Use input grid informations from namelist and bathymetry file to generate MITgcm boundary conditions
• mds: Use input grid informations from grid info mds (XC,YC,RC,hFacC,...) files to generate MITgcm boundary conditions.

mkMITgcmBC igrid¶

Use input grid informations from namelist and bathymetry file to generate MITgcm boundary conditions

Usage:

mkMITgcmBC igrid [OPTIONS]

Options:

  --input TEXT          Input can be:

                         1. A NetCDF file.

                         2. A valid cdo option which will generate a NetCDF
                         file.

                         e.g. "-mergetime input1.nc input2.nc input3.nc"
                         \[required]
  --nx INTEGER          Number of points in x-direction  \[required]
  --ny INTEGER          Number of points in y-direction  \[required]
  --field TEXT          Boundary field name, i.e. T, S, U, V, Eta

                        e.g.; This will be used to generate files
                        <field>_E.bin, <field>_W.bin,.. For field "U" and "V",
                        West and South grid coordinates of Arakawa-C will be
                        used respectively. For all other fields Center grid
                        coordinates of Arakawa-C will be used.  \[required]
  --run-dir PATH        Path to the MITgcm run directory where all neccesary
                        files are present  \[default: .]
  --boundary [S|N|E|W]  boundary; can be defined multiple times

                        e.g. --boundary S --boundary N --boundary E
  --addc FLOAT          Add a constant to the input field  \[default: 0.0]
  --mulc FLOAT          Multiply a constant to the input field  \[default:
                        1.0]
  --help                Show this message and exit.

mkMITgcmBC mds¶

Use input grid informations from grid info mds (XC,YC,RC,hFacC,...) files to generate MITgcm boundary conditions. The input file must be a CF-compliant NetCDF file and should contain a single data variable. If the input file contains multiple data variables, use cdo operator "-selvar" to select a single data variable. Example:

• mkMITgcmBC mds --grid-path mds_grid_info_files_directory_path/ --field T --boundary E --input "-mergetime [ input_data_*.nc ]"

• mkMITgcmBC mds --grid-path mds_grid_info_files_directory_path/ --field U --boundary E --boundary N --input "-selvar,uvel input_data.nc"

Usage:

mkMITgcmBC mds [OPTIONS]

Options:

  --input TEXT          Input can be:

                         1. A CF-compliant NetCDF file.

                         2. A valid cdo option which will generate a NetCDF
                         file.

                         e.g. "-mergetime input1.nc input2.nc input3.nc"
                         \[required]
  --field TEXT          Boundary field name, i.e. T, S, U, V

                        e.g.; This will be used to generate files
                        <field>_E.bin, <field>_W.bin,..

                        For field "U" and "V", West and South grid coordinates
                        of Arakawa-C will be used respectively.

                        For all other fields Center grid coordinates of
                        Arakawa-C will be used.   \[required]
  --grid-path PATH      Directory path where grid info mds files are
                        \[default: .]
  --boundary [S|N|E|W]  boundary; can be defined multiple times

                        e.g. --boundary S --boundary N --boundary E
  --addc FLOAT          Add a constant to the input field  \[default: 0.0]
  --mulc FLOAT          Multiply a constant to the input field  \[default:
                        1.0]
  --help                Show this message and exit.