NOAA-GFDL / CEFI-regional-MOM6

A repository containing essential tools, XML files, and source codes for collaborators of the Climate, Ecosystems, and Fisheries Initiative (CEFI) to conduct simulations.
Other
19 stars 16 forks source link

mom6_obgc_1d doc

CEFI-regional-MOM6

NOAA is embarking on an ambitious effort, the Climate, Ecosystems and Fisheries Initiative (CEFI), to develop and deploy a nation-wide ocean modeling, prediction, and decision support system to meet the challenge of coastal ecosystem management in a changing climate.

As described in the link above, CEFI will integrate expertise and capabilities across NOAA’s line offices to accomplish this task, establishing strong feedback loops between model development and the intended application. The primary role of NOAA’s office of Oceanic and Atmospheric Research (OAR) in this effort is the development and delivery of a national network of ocean modeling and predictions systems for climate-scale applications, including seasonal predictions (12 months), decadal predictions (10 years), and multi-decadal projections (to the end of the 21st century). These simulations must include both physical and biogeochemical drivers of ecosystem change, must be of sufficient resolution to capture continental shelf-scale dynamics critical for fisheries and other living marine resources, and must include sufficient ensembles to quantify uncertainties.

This repository contains pre/post-processing tools and CEFI regional-MOM6 configurations for running regional-MOM6 OBGC simulations. Users are welcome to use the discussions board to ask questions related to the model or the tools.

Documentation (in progress) is available here

What files are what

File/directory Purpose
LICENSE.md A copy of the Gnu lesser general public license, version 3.
README.md This file with basic pointers to more information.
src/ Contains the source code for CEFI-regional-MOM6
builds/ Contains build script to build MOM6-SIS2-cobalt
diagnostics/ Contains python scripts that can be utilized for analyzing model results after postprocessing. See diagnostics/README.md
exps/ Contains 1D mom6-cobalt exmaple and NWA12 configurtions. See exps/README.md
tools/ Contains tools that can be used to generate initial conditions (ICs), boundary conditions (BCs), and other required inputs for MOM6-SIS2-cobalt model runs. See tools/README.md
xmls/ Contains FRE xml files designed for running the CEFI-regional-MOM6 workflow on NOAA Gaea C5. See xmls/README.md
docs/ Contains release notes, documentation, and User’s Guide

Quick Start Guide

To learn how to compile/build MOM6-SIS2-cobalt and run an example regional test case, refer to builds/README and exps/README.md. Users who are interested in model inputs generation can check tools/README.md.

Disclaimer

The United States Department of Commerce (DOC) GitHub project code is provided on an 'as is' basis and the user assumes responsibility for its use. The DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.

This project code is made available through GitHub but is managed by NOAA-GFDL at https://www.gfdl.noaa.gov.