Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 2.43 KB

README.md

File metadata and controls

40 lines (25 loc) · 2.43 KB

CrocoDash

CrocoDash is a Python package designed to setup regional Modular Ocean Model 6 (MOM6) cases within the Community Earth System Model (CESM). CrocoDash takes advantage and integrates several MOM6 and CESM tools into an unified workflow for regional MOM6 case configuration.

Background

One independent package that sets up a regional MOM run is the regional-mom6 (RM6) package. Starting with RM6, CrocoDash wraps RM6 and spun off its workflow to setup a workflow inside the CESM.

Motivation:

There's a few different motivations. Please see the overall CROCODILE project for scientific motivation. This package was started because we have some "NCAR and CESM-specific" items that don't have a place in the independent package, RM6. Since then, CrocoDash provides a platform to combine many MOM6 and CESM tools to create an sum greater than the parts for regional cases.

Description:

The framework here is called CrocoDash (CD). The major basic difference between a package like RM6 and CrocoDash is that CrocoDash brings in MOM6 inside the CESM.

CrocoDash is a lightweight package that ties together each part of the MOM6 in CESM setup process into one package.

Getting Familiar (Installation):

Installation:

  1. The first step is cloning WITH the submodules: git clone --recurse-submodules git@github.com:CROCODILE-CESM/CrocoDash.git
  2. Install the environment (which we fail if the submodules aren't installed): mamba env create -f environment.yml
  3. Activate the environment: mamba activate CrocoDash
  4. Test installation with: pytest tests/test_installation.py

Going with this flow, there are a few demos (one for each avenue) to get used to the CrocoDash.

  1. One is called minimal_demo_rect. It creates a rectangular case from grid generation to CESM case submission.

  2. Another demo is called minimal_demo_subset_global, which is similar to the previous demo with but subsets a global grid instead of generating a rectangular grid.

  3. Another demo showcases the ability to have less than four boundaries in a regional domain. The demo is minimal_demo_three_boundary.

Documentation:

Check out our documentation in the docs/ folder, or at the website: https://crocodile-cesm.github.io/CrocoDash/.