CrocoDash package

Subpackages

• CrocoDash.raw_data_access package
  • Subpackages
    • CrocoDash.raw_data_access.datasets package
      • Submodules
      • CrocoDash.raw_data_access.datasets.glorys module
      • CrocoDash.raw_data_access.datasets.seawifs module
      • CrocoDash.raw_data_access.datasets.utils module
      • Module contents
  • Submodules
  • CrocoDash.raw_data_access.config module
    • category_of_product()
    • function_exists()
    • list_functions()
    • list_products()
    • load_tables()
    • load_varnames_config()
    • product_exists()
    • type_of_function()
  • CrocoDash.raw_data_access.driver module
    • ProductFunctionRegistry
      • ProductFunctionRegistry.list_importable_functions()
      • ProductFunctionRegistry.load_functions()
      • ProductFunctionRegistry.validate_function()
      • ProductFunctionRegistry.verify_data_sufficiency()
    • get_rectangular_segment_info()
  • CrocoDash.raw_data_access.utils module
    • fill_template()
    • load_config()
    • setup_logger()
  • Module contents
• CrocoDash.rm6 package
  • Subpackages
    • CrocoDash.rm6.regional_mom6 package
      • Submodules
      • CrocoDash.rm6.regional_mom6.MOM_parameter_tools module
      • CrocoDash.rm6.regional_mom6.config module
      • CrocoDash.rm6.regional_mom6.regional_mom6 module
      • CrocoDash.rm6.regional_mom6.regridding module
      • CrocoDash.rm6.regional_mom6.rotation module
      • CrocoDash.rm6.regional_mom6.utils module
      • Module contents
  • Module contents

Submodules

CrocoDash.case module

class CrocoDash.case.Case(*, cesmroot: str | Path, caseroot: str | Path, inputdir: str | Path, ocn_grid: Grid, ocn_topo: Topo, ocn_vgrid: VGrid, inittime: str = '1850', datm_mode: str = 'JRA', datm_grid_name: str = 'TL319', ninst: int = 1, machine: str | None = None, project: str | None = None, override: bool = False)

Bases: object

This class represents a regional MOM6 case within the CESM framework. It is similar to the Experiment class in the regional_mom6 package, but with modifications to work within the CESM framework.

configure_forcings(date_range: list[str], boundaries: list[str] = ['south', 'north', 'west', 'east'], tidal_constituents: list[str] | None = None, tpxo_elevation_filepath: str | Path | None = None, tpxo_velocity_filepath: str | Path | None = None, product_name: str = 'GLORYS', function_name: str = 'get_glorys_data_script_for_cli', too_much_data: bool = False)

Configure the boundary conditions and tides for the MOM6 case.

Sets up initial and boundary condition forcing data for MOM6 using a specified product and download function. Optionally configures tidal constituents if specified. Supports a large data workflow mode that defers data download and processing to an external script.

Parameters:

• date_range (list of str) – Start and end dates for the forcing data, formatted as strings. Must contain exactly two elements.

• boundaries (list of str, optional) – List of open boundaries to process (e.g., [“south”, “north”]). Default is [“south”, “north”, “west”, “east”].

• tidal_constituents (list of str, optional) – List of tidal constituents (e.g., [“M2”, “S2”]) to be used for tidal forcing. If provided, both TPXO elevation and velocity file paths must also be provided.

• tpxo_elevation_filepath (str or Path, optional) – File path to the TPXO tidal elevation data file.

• tpxo_velocity_filepath (str or Path, optional) – File path to the TPXO tidal velocity data file.

• product_name (str, optional) – Name of the forcing data product to use. Default is “GLORYS”.

• function_name (str, optional) – Name of the function to call for downloading the forcing data. Default is “get_glorys_data_script_for_cli”.

• too_much_data (bool, optional) – If True, configures the large data workflow. In this case, data are not downloaded immediately, but a config file and workflow directory are created for external processing in the forcing directory, inside the input directory.

Raises:

• TypeError – If inputs such as date_range, boundaries, or tidal_constituents are not lists of strings.

• ValueError – If date_range does not have exactly two elements, or if tidal arguments are inconsistently specified. Also raised if an invalid product or function is provided.

• AssertionError – If the selected data product is not categorized as a forcing product.

Notes

• Creates an regional_mom6.experiment instance with the specified domain and inputs.

• Downloads forcing data (or creates a script) for each boundary and the initial condition unless the large data workflow is used.

• In large data workflow mode, creates a folder structure and config.json file for later manual processing.

• Tidal forcing requires all of: tidal_constituents, tpxo_elevation_filepath, and tpxo_velocity_filepath.

• This method must be called before process_forcings().

See also

process_forcings

Executes the actual boundary, initial condition, and tide setup based on the configuration.

property date_range: list[datetime]

property name: str

process_forcings(process_initial_condition=True, process_tides=True, process_velocity_tracers=True, process_param_changes=True)

Process boundary conditions, initial conditions, and tides for a MOM6 case.

This method configures a regional MOM6 case’s ocean state boundaries and initial conditions using previously downloaded data setup in configure_forcings. It also processes tidal boundary conditions if tidal constituents are specified. The method expects configure_forcings() to be called beforehand.

Parameters:

• process_initial_condition (bool, optional) – Whether to process the initial condition file. Default is True.

• process_tides (bool, optional) – Whether to process tidal boundary conditions. Default is True.

• process_velocity_tracers (bool, optional) – Whether to process velocity and tracer boundary conditions. Default is True. This will be overridden and set to False if the large data workflow in configure_forcings is enabled.

• process_param_changes (bool, optional) – Whether to process the namelist and xml changes required to run a regional MOM6 case in the CESM.

Raises:

• RuntimeError – If configure_forcings() was not called before this method.

• FileNotFoundError – If required unprocessed files are missing in the expected directories.

Notes

• This method uses variable name mappings specified in the forcing product configuration.

• If the large data workflow has been enabled, velocity and tracer OBCs are not processed within this method and must be handled externally.

• If tidal constituents are configured, TPXO elevation and velocity files must be available.

• Applies forcing-related namelist and XML updates at the end of the method.

See also

configure_forcings

Must be called before this method to set up the environment.

CrocoDash.grid module

CrocoDash.topo module

class CrocoDash.topo.Topo(grid, min_depth)

Bases: Topo

interpolate_from_file(*, file_path, longitude_coordinate_name, latitude_coordinate_name, vertical_coordinate_name, fill_channels=False, positive_down=False, write_to_file=False)

CrocoDash.topo_editor module

CrocoDash.utils module

This module (utils) contains utility functions that are used across the CrocoDash package.

CrocoDash.utils.export_dataset(ds, path)

This function exports an xarray dataset to a netcdf file at the specified path, but deletes the previous netcdf beforehand for safety.

Parameters:

• ds (xarray.Dataset) – The dataset to export.

• path (str) – The path to the netcdf file to export

Return type:

None

CrocoDash.utils.setup_logger(name)

This function sets up a logger format for the package. It attaches logger output to stdout (if a handler doesn’t already exist) and formats it in a pretty way!

Parameters:

name (str) – The name of the logger.

Returns:

The logger

Return type:

logging.Logger

CrocoDash.vgrid module

Module contents