add SCHISM submodule and build files

.gitmodules

@@ -29,3 +29,9 @@
 [submodule "BARDATA"]
 	path = BARDATA
 	url = https://github.com/noaa-ocs-modeling/BARDATA
+[submodule "SCHISM/schism"]
+	path = SCHISM/schism
+	url = https://github.com/schism-dev/schism.git
+[submodule "SCHISM/schism-esmf"]
+	path = SCHISM/schism-esmf
+	url = https://github.com/schism-dev/schism-esmf.git

README.md

@@ -4,15 +4,41 @@
 [![build](https://github.com/noaa-ocs-modeling/ADC-WW3-NWM-NEMS/workflows/build/badge.svg)](https://github.com/noaa-ocs-modeling/ADC-WW3-NWM-NEMS/actions?query=workflow%3Abuild)
 [![license](https://img.shields.io/github/license/noaa-ocs-modeling/ADC-WW3-NWM-NEMS)](https://creativecommons.org/share-your-work/public-domain/cc0)
 
-ESMF application for building a NUOPC / NEMS application coupling ADCIRC, ATMESH, WW3 / WW3DATA, and NWM.
+ESMF application for building a NUOPC / NEMS application coupling
+circulation models (ADCIRC, SCHISM) with forcing models (WW3, NWM) or
+even file forcings (ATMESH, WW3DATA).
 
-`CoastalApp` is an ESMF application developed as part of the Coastal Act coupling project to determine wind versus water percentage loss caused by a Named Storm Event. 
+`ADC-WW3-NWM-NEMS` is an ESMF application developed as part of the
+Coastal Act coupling project to determine wind versus water percentage
+loss caused by a Named Storm Event.
 
 ```bash
 git clone --recursive https://github.com/noaa-ocs-modeling/CoastalApp
 cd CoastalApp
 ```
 
+## Requirements
+
+#### installing ParMETIS for WW3
+
+Using unstructured WW3 requires an installation of ParMETIS for domain
+decomposition.
+
+1. [download the code here](http://glaros.dtc.umn.edu/gkhome/metis/parmetis/download)
+2. build ParMETIS
+    ```bash
+    module purge
+    module load intel impi
+    setenv CFLAGS -fPIC
+    make config cc=mpiicc cxx=mpiicc prefix=/path/to/your/parmetis/ | & tee config.out-rr
+    make install | & tee make-install.out-rr
+    ```
+   This adds `libparmetis.a`
+   under `/path/to/your/parmetis/lib/libparmetis.a`.
+3. set the path to ParMETIS
+    ```bash
+    setenv METIS_PATH /path/to/your/parmetis
+    ```
 ## Organization / Responsibility
 
 #### `NEMS` application implementing ESMF / NUOPC coupling
@@ -50,15 +76,39 @@ cd CoastalApp
 
 ## Compilation
 
+This section contains some generic instructions of how to build the NEMS
+application. The contents of this section will change soon.
+
+```bash
+./build.sh --help
+```
+
+The following example builds `NEMS.x` with ADCIRC, ATMESH, and WW3DATA,
+using variables / modules from the Hera environment, compiling with the
+Intel compiler, and cleaning before building.
+
 ```bash
 ./build.sh --component "ADCIRC ATMESH WW3DATA" --plat hera --compiler intel --clean -2 
 ```
 
+### Components
+
 - `--component` can be any combination of
     - `ADCIRC`
     - `ATMESH`
     - `WW3` / `WW3DATA`
     - `NWM`
+
+```bash
+./build.sh --component "ADCIRC WW3" --plat hera --compiler intel --clean -2 
+```
+
+```bash
+./build.sh --component "SCHISM" --plat orion --compiler intel --clean -2
+```
+
+### Platforms
+
 - `--plat` can be one of
     - `hera`
     - `stampede`
@@ -69,43 +119,62 @@ cd CoastalApp
     - `cheyenne`
     - `linux`
     - `macosx`
+    - `macports`
+
+For MacOS running MacPorts, use the `macports` option.
+
+```bash
+./build.sh --component "SCHISM" --plat hera --compiler intel --clean -2
+```
+
+```bash
+./build.sh --component "SCHISM" --plat orion --compiler intel --clean -2
+```
+
+### Compiler
+
 - `--compiler` can be one of
     - `intel`
     - `gnu`
     - `pgi`
+
+```bash
+./build.sh --component "SCHISM" --compiler gnu --plat macports
+```
+
+```bash
+./build.sh --component "SCHISM" --compiler intel --plat hera
+```
+
+### Clean
+
 - `--clean` is optional, and can be one of
     - ` ` (`make clean` and exit)
     - `1` (`make clean` and exit)
     - `2` (`make clobber` and exit)
     - `-1` (`make clean` and build)
     - `-2` (`make clobber` and build)
 
-#### adding a new platform / compiler to compilation script
+```bash
+./build.sh --component "SCHISM" --compiler intel --plat hera --clean
+```
 
-Environment files are stored in `modulefiles/` with the filename `envmodules_<COMPILER>.<PLATFORM>`
+```bash
+./build.sh --component "SCHISM" --compiler intel --plat hera --clean -1
+```
 
-To compile in your own system you should create a similar file, then run `build.sh` to compile.
+## Contributing
 
-## Requirements
+Feel free to fork this repository and create a pull request with
+contributions.
 
-#### installing ParMETIS for WW3
+#### adding a new platform / compiler to compilation script
 
-Using unstructured WW3 requires an installation of ParMETIS for domain decomposition.
+Environment files are stored in `modulefiles/` with the
+filename `envmodules_<COMPILER>.<PLATFORM>`
 
-1. [download the code here](http://glaros.dtc.umn.edu/gkhome/metis/parmetis/download)
-2. build ParMETIS
-    ```bash
-    module purge
-    module load intel impi
-    setenv CFLAGS -fPIC
-    make config cc=mpiicc cxx=mpiicc prefix=/path/to/your/parmetis/ | & tee config.out-rr
-    make install | & tee make-install.out-rr
-    ```
-   This adds `libparmetis.a` under `/path/to/your/parmetis/lib/libparmetis.a`.
-3. set the path to ParMETIS
-    ```bash
-    setenv METIS_PATH /path/to/your/parmetis
-    ```
+To compile in your own system you should create a similar file, then
+run `build.sh` to compile.
 
 ## Collaboration
 

SCHISM/.gitignore

@@ -0,0 +1 @@
+build

conf/configure.nems.femto.intel

@@ -0,0 +1,56 @@
+## NEMS configuration file
+##
+## Platform: Hera
+## Compiler: Intel with IntelMPI
+
+SHELL           = /bin/sh
+
+################################################################################
+## Include the common configuration parts
+include         $(TOP)/conf/configure.nems.NUOPC
+
+################################################################################
+## Other settings
+
+NETCDF_INC   = -I$(NETCDF)/include
+NETCDF_LIB   = -L$(NETCDF)/lib -lnetcdf
+
+NEMSIO_INC   = -I${LIBDIR}/incmod/nemsio
+NEMSIO_LIB   = -L${LIBDIR} -lnemsio
+SYS_LIB      =
+
+EXTLIBS      = $(NEMSIO_LIB) \
+               $(NETCDF_LIB) \
+               $(ESMF_LIB)   \
+               $(SYS_LIB) -lm
+
+EXTLIBS_POST = $(NEMSIO_LIB)  \
+               $(ESMF_LIB)    \
+               $(NETCDF_LIB)  \
+               $(SYS_LIB)
+###
+FC          = mpifort -g -qopenmp -mkl=sequential -align array32byte -lmkl_intel_lp64 -lmkl_core -lmkl_sequential -lpthread -qopenmp -convert big_endian -assume byterecl -mkl=sequential
+F77         = mpifort -g -qopenmp -mkl=sequential -align array32byte -lmkl_intel_lp64 -lmkl_core -lmkl_sequential -lpthread -qopenmp -convert big_endian -assume byterecl -mkl=sequential
+FREE         = -free
+FIXED        = -fixed
+R8           = -r8
+
+FINCS        = $(ESMF_INC) $(NEMSIO_INC) $(NETCDF_INC)
+#TRAPS        = -g -fno-inline -no-ip -traceback -ftrapuv -fpe0 -ftz -check all -check noarg_temp_created -fp-stack-check
+
+FFLAGS       = $(TRAPS) $(FINCS) -fp-model strict
+
+OPTS_NMM     = -g -fno-inline -no-ip -traceback -ftrapuv -fpe0 -ftz -check all -check noarg_temp_created -fp-stack-check $(FREE)
+
+FFLAGM_DEBUG =
+
+FFLAGS_NMM   = $(MACROS_NWM) $(OPTS_NMM) $(FFLAGS)
+
+FPP          = -fpp
+CPP          = cpp -P -traditional
+CPPFLAGS     = -DENABLE_SMP -DCHNK_RRTM=8 
+
+AR           = ar
+ARFLAGS      = -r
+
+RM           = rm

conf/configure.nems.macosx.gnu

@@ -0,0 +1,60 @@
+## NEMS configuration file
+##
+## Platform: Generic/Linux
+## Compiler: GNU with MPI   --- needs fixing
+
+SHELL           = /bin/sh
+
+################################################################################
+## Include the common configuration parts
+include         $(TOP)/conf/configure.nems.NUOPC
+
+################################################################################
+## Other settings
+#
+CC=mpicc
+CXX=mpicxx
+FC=mpifort
+
+NETCDF_INC   = -I$(NETCDF_INCDIR)
+NETCDF_LIB   = -L$(NETCDF_LIBDIR) -lnetcdf
+
+NEMSIO_INC   = -I${LIBDIR}/incmod/nemsio
+NEMSIO_LIB   = -L${LIBDIR} -lnemsio
+SYS_LIB      =
+
+EXTLIBS      = $(NEMSIO_LIB) \
+               $(NETCDF_LIB) \
+               $(ESMF_LIB)   \
+               $(SYS_LIB) -lm
+
+EXTLIBS_POST = $(NEMSIO_LIB)  \
+               $(ESMF_LIB)    \
+               $(NETCDF_LIB)  \
+               $(SYS_LIB)
+###
+FC          = mpifort -g -ffree-line-length-none -fno-range-check -fbacktrace
+F77         = mpifort -g -ffree-line-length-none -fno-range-check -fbacktrace
+FREE         = -free
+FIXED        = -fixed
+R8           = -r8
+
+FINCS        = $(ESMF_INC) $(NEMSIO_INC) $(NETCDF_INC)
+#TRAPS        = ???
+
+FFLAGS       = $(TRAPS) $(FINCS) 
+
+OPTS_NMM     = -g -ffree-line-length-none -fno-range-check -fbacktrace $(FREE)
+
+FFLAGM_DEBUG =
+
+FFLAGS_NMM   = $(MACROS_NWM) $(OPTS_NMM) $(FFLAGS)
+
+FPP          = -fpp
+CPP          = cpp -P -traditional
+CPPFLAGS     = -DENABLE_SMP -DCHNK_RRTM=8 
+
+AR           = ar
+ARFLAGS      = -r
+
+RM           = rm

conf/configure.nems.macports.gnu

@@ -0,0 +1,60 @@
+## NEMS configuration file
+##
+## Platform: Generic/Linux
+## Compiler: GNU with MPI   --- needs fixing
+
+SHELL           = /bin/sh
+
+################################################################################
+## Include the common configuration parts
+include         $(TOP)/conf/configure.nems.NUOPC
+
+################################################################################
+## Other settings
+#
+CC=mpicc
+CXX=mpicxx
+FC=mpifort
+
+NETCDF_INC   = -I$(NETCDF_INCDIR)
+NETCDF_LIB   = -L$(NETCDF_LIBDIR) -lnetcdf
+
+NEMSIO_INC   = -I${LIBDIR}/incmod/nemsio
+NEMSIO_LIB   = -L${LIBDIR} -lnemsio
+SYS_LIB      =
+
+EXTLIBS      = $(NEMSIO_LIB) \
+               $(NETCDF_LIB) \
+               $(ESMF_LIB)   \
+               $(SYS_LIB) -lm
+
+EXTLIBS_POST = $(NEMSIO_LIB)  \
+               $(ESMF_LIB)    \
+               $(NETCDF_LIB)  \
+               $(SYS_LIB)
+###
+FC          = mpifort -g -ffree-line-length-none -fno-range-check -fbacktrace -fallow-argument-mismatch
+F77         = mpifort -g -ffree-line-length-none -fno-range-check -fbacktrace
+FREE         = -free
+FIXED        = -fixed
+R8           = -r8
+
+FINCS        = $(ESMF_INC) $(NEMSIO_INC) $(NETCDF_INC)
+#TRAPS        = ???
+
+FFLAGS       = $(TRAPS) $(FINCS) 
+
+OPTS_NMM     = -g -ffree-line-length-none -fno-range-check -fbacktrace $(FREE)
+
+FFLAGM_DEBUG =
+
+FFLAGS_NMM   = $(MACROS_NWM) $(OPTS_NMM) $(FFLAGS)
+
+FPP          = -fpp
+CPP          = cpp -P -traditional
+CPPFLAGS     = -DENABLE_SMP -DCHNK_RRTM=8 
+
+AR           = ar
+ARFLAGS      = -r
+
+RM           = rm