Initialization Process for CEFI-regional-MOM6

.github/workflows/mom6_cobalt_1D.yaml

@@ -0,0 +1,55 @@
+name: mom6_obgc_1d
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    env:
+      PR_NUMBER: ${{ github.event.number }}
+
+    steps:        
+    - name: Checkout
+      uses: actions/checkout@v3
+      with:
+        submodules: recursive
+
+    - uses: jitterbit/get-changed-files@v1
+      id: abc
+      with:
+        format: space-delimited
+        token: ${{ secrets.GITHUB_TOKEN }}        
+
+#    - name: Login to DockerHub Registry
+#      run: echo ${{ secrets.DOCKERHUB_PASSWORD }} | docker login -u ${{ secrets.DOCKERHUB_USERNAME }} --password-stdin
+
+    - name: Build mom6_obgc 1D Docker Image
+      run: |
+        echo "maximize disk space on git-runner ..."
+        df -h 
+        sudo rm -rf /usr/share/dotnet
+        sudo rm -rf /opt/ghc
+        sudo rm -rf "/usr/local/share/boost"
+        sudo rm -rf "$AGENT_TOOLSDIRECTORY"
+        df -h
+        echo "docker image build ..."
+        docker build --file "./ci/docker/Dockerfile.ci" -t mom6_obgc_1d:develop .
+
+    - name: Check mom6_obgc 1D Docker Image build
+      run: | 
+       docker images 
+       if [[ $(docker image inspect mom6_obgc_1d:develop) ]]; then
+            echo "mom6_obgc_1d:develop generated ..."          
+       else
+            echo "mom6_obgc_1d:develop was not generated ..."
+            exit 1
+       fi
+
+#    - name: Docker Logout
+#      run: |
+#       docker logout   

.gitignore

@@ -0,0 +1,4 @@
+# Ignore vim and emacs files
+*.swp
+*~
+html

.gitmodules

@@ -0,0 +1,40 @@
+[submodule "src/mkmf"]
+	path = src/mkmf
+	url = https://github.com/NOAA-GFDL/mkmf.git
+	branch = master
+[submodule "src/FMS"]
+	path = src/FMS
+	url = https://github.com/NOAA-GFDL/FMS.git
+	branch = 2022.04
+[submodule "src/icebergs"]
+	path = src/icebergs
+	url = https://github.com/NOAA-GFDL/icebergs.git
+	branch = dev/gfdl
+[submodule "src/coupler"]
+	path = src/coupler
+	url = https://github.com/NOAA-GFDL/coupler.git
+	branch = 2022.04
+[submodule "src/atmos_null"]
+	path = src/atmos_null
+	url = https://github.com/NOAA-GFDL/atmos_null.git
+	branch = 2021.03
+[submodule "src/land_null"]
+	path = src/land_null
+	url = https://github.com/NOAA-GFDL/land_null.git
+	branch = 2021.03
+[submodule "src/ice_param"]
+	path = src/ice_param
+	url = https://github.com/NOAA-GFDL/ice_param.git
+	branch = 2021.03
+[submodule "src/SIS2"]
+	path = src/SIS2
+	url = https://github.com/NOAA-GFDL/SIS2.git
+	branch = dev/gfdl
+[submodule "src/MOM6"]
+	path = src/MOM6
+	url = https://github.com/NOAA-CEFI-Regional-Ocean-Modeling/MOM6.git
+	branch = dev/cefi
+[submodule "src/ocean_BGC"]
+	path = src/ocean_BGC
+	url = https://github.com/NOAA-CEFI-Regional-Ocean-Modeling/ocean_BGC
+	branch = dev/cefi

README.md

@@ -0,0 +1,26 @@
+# CEFI-regional-MOM6
+This repository contains pre/post-processing tools and CEFI regional-MOM6 configurations for running regional-MOM6 OBGC simulations.
+The development branch of the CEFI-regional-MOM6 is continually evolving as the system undergoes open development. The main branch represents a snapshot of this continuously evolving system.
+Users are welcome to use the [discussions board](https://github.com/NOAA-GFDL/CEFI-regional-MOM6/discussions) to ask questions related to the model or the tools.
+
+## 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](diagnostics/README.md) |
+| ```exps/```       | Contains 1D mom6-cobalt exmaple and NWA12 configurtions. See [exps/README.md](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](tools/README.md) |
+| ```xmls/```       | Contains FRE xml files designed for running the CEFI-regional-MOM6 workflow on NOAA Gaea C5. See [xmls/README.md](xmls/README.md) |
+
+## Quick Start Guide
+To learn how to compile/build MOM6-SIS2-cobalt and run an example regional test case, refer to [builds/README](builds/README) and [exps/README.md](exps/README.md).
+Users who are interested in model inputs generation can check [tools/README.md](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](https://www.gfdl.noaa.gov).

builds/README

@@ -0,0 +1,11 @@
+This tool can be use to build the executable for the model.
+E.g., on machine gaea for platform c5 with intel23 compiler:
+
+./linux-build.bash -m gaea -p ncrc5.intel23 -t prod -f mom6sis2
+
+This assumes that the files build/gaea/ncrc5.intel23.env and build/gaea/ncrc5.intel23.mk exist.
+-  build/gaea/ncrc5.intel23.env contains all the necessary environment variables and modules
+that must be loaded before a build / run on that machine
+-  build/gaea/ncrc5.intel23.mk  contains the compile instructions for the particular compiler and machine
+
+