Skip to content

Commit

Permalink
Merge branch 'gfdl-to-main-2024-05-16'
Browse files Browse the repository at this point in the history
  • Loading branch information
adcroft committed Jul 30, 2024
2 parents 8a50275 + 729b231 commit 03bc432
Show file tree
Hide file tree
Showing 92 changed files with 35,810 additions and 6,792 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/documentation-and-style.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Doxygen completeness

on: [push, pull_request]

jobs:
doxygen:

runs-on: ubuntu-20.04

steps:
- uses: actions/checkout@v2

- name: Install packages used when generating documentation
run: |
sudo apt-get update
sudo apt-get install doxygen graphviz
- name: Build doxygen HTML
run: |
cd docs
doxygen
- name: Report doxygen errors
run: |
cat docs/doxygen.log
test ! -s docs/doxygen.log
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
CVS
*~
*core
notes
700 changes: 161 additions & 539 deletions LICENSE.md

Large diffs are not rendered by default.

34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
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. 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.
# KID (icebergs)

[![Documentation Status](https://readthedocs.org/projects/kid/badge/?version=latest)](https://kid.readthedocs.io/en/latest/?badge=latest)

# What files are what

| File/directory | Purpose |
| -------------- | ------- |
| src/ | Source code for icebergs |
| driver/ | A driver for creating a stand-alone (uncoupled to ocean/atmosphere) model |
| build/ | A workspace for building a stand alone executable using src/ and driver/ |
| tests/ | Test cases |
| docs/ | A workspace for generating documentation with doxygen and sphinx |

# 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. 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://gitlab.gfdl.noaa.gov.
8 changes: 8 additions & 0 deletions build/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
path_names
Makefile
bergs.x
logfile.000000.out
.bergs.x.cppdefs
*.mod
*.o
core
12 changes: 12 additions & 0 deletions build/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
To create a `Makefile` (for FMS2):
```
source mkmkf_fms2
```
Or for FMS1:
```
mkmkf
```
Then, to compile a "debug" executable:
```
source mkcmd
```
3 changes: 3 additions & 0 deletions build/diag_table
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
"icebergs test"
1 1 1 0 0 0

18 changes: 18 additions & 0 deletions build/env
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#module unload PrgEnv-pgi
#module unload PrgEnv-pathscale
#module unload PrgEnv-intel
#module unload PrgEnv-gnu
#module unload PrgEnv-cray

module load PrgEnv-intel
module load intel-classic/2022.0.2
#module swap intel intel/18.0.6.288
#module load intel
#module unload netcdf
module load cray-hdf5
module load cray-netcdf

module switch cray-libsci/22.10.1.2
#module load cray-hdf5/1.12.1.3
#module load cray-netcdf/4.8.1.3
#module load cray-hdf5
1 change: 1 addition & 0 deletions build/mkcmd
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
make NETCDF=3 DEBUG=1 bergs.x -j
7 changes: 7 additions & 0 deletions build/mkmkf
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# rm -f path_names
# ../../mkmf/bin/list_paths ../../FMS/{mpp,diag_manager,time_manager,include,memutils,constants,platform,fms,random_numbers,mosaic,exchange} ../src/ ../driver/
# ../../mkmf/bin/mkmf -t ../../mkmf/templates/ncrc-intel.mk -c "-Duse_libMPI -Duse_netCDF" -p bergs.x path_names

rm -f path_names
../../mkmf/bin/list_paths -l ../src/ ../driver/
../../mkmf/bin/mkmf -t ../../mkmf/templates/ncrc-intel.mk -o "-I../../../build/fms" -p bergs.x -l '-L../../../build/fms -lfms' -c "-Duse_libMPI -Duse_netCDF -I../../../build/fms" path_names
3 changes: 3 additions & 0 deletions build/mkmkf_fms2
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
rm -f path_names
../../mkmf/bin/list_paths -l ../src/ ../driver/
../../mkmf/bin/mkmf -t ../../mkmf/templates/ncrc-intel.mk -o "-I../../../build/fms2" -p bergs.x -l '-L../../../build/fms2 -lfms' -c "-Duse_libMPI -Duse_netCDF -DUSE_FMS2_IO -I../../../build/fms2" path_names
3 changes: 3 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
_build
html
doxygen.log
Loading

0 comments on commit 03bc432

Please sign in to comment.