CrocoDash Documentation

Welcome to the CrocoDash Documentation! Get quick-started by heading over to Installation!

Background

CrocoDash is part of the CROCODILE project, and spun off of the regional-mom6 (RM6) package, an independent package that sets up a regional MOM run. CrocoDash wraps RM6 (for OBC construction & some grid generation) to setup a workflow inside the CESM.

Motivation

Please see the overall CROCODILE project for scientific motivation. CrocoDash provides a platform to combine MOM6 and CESM tools to create a sum greater than the parts for regional cases.

Description

CrocoDash brings regional MOM6 inside the CESM. It is a lightweight package that ties together each part of the MOM6 in CESM setup process into one package. 1. Grid Generation (Through mom6_bathy and regional-mom6) 2. CESM Setup (Through VisualCaseGen) 3. Forcing + OBC Setup (Through CESM & regional-mom6)

CrocoDash also provides a variety of helper tools to help setup a case, for example, a tool to edit bathymetry (TopoEditor) or a tool to download public datasets simply (data_access module).

Demos

There are a few demos to get used to the CrocoDash. Check out the demos folder:

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 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.

Contents:

• Installation
• Demos
  • Set up a rectangular regional CESM-MOM6 run
  • SECTION 1: Generate a regional MOM6 domain
  • SECTION 2: Create the CESM case
  • Section 3: Prepare ocean forcing data
  • Section 4: Build and run the case
  • Set up a global gridded subset regional CESM-MOM6 run
  • SECTION 1: Generate a regional MOM6 domain
  • SECTION 2: Create the CESM case
  • Section 3: Prepare ocean forcing data
  • Section 4: Build and run the case
  • Set up a three boundary regional CESM-MOM6 run
  • SECTION 1: Generate a regional MOM6 domain
  • SECTION 2: Create the CESM case
  • Section 3: Prepare ocean forcing data
  • Section 4: Build and run the case
  • Set up a low res three boundary regional CESM-MOM6 run
  • SECTION 1: Generate a regional MOM6 domain
  • SECTION 2: Create the CESM case
  • Section 3: Prepare ocean forcing data
  • Section 4: Build and run the case
  • Set up a Regional MOM6 case with your own grids!
  • The CrocoDash Data Access Module
• Additional Information
  • CrocoDash Structure
  • Diagrams
  • Datasets
• Developer Information
  • Write Documentation
  • Adding Data to the Data Access Module
• API Documentation
  • CrocoDash package

You can also check out the Regional MOM6 documentation for more support information about those functions here!