Merge pull request NOAA-EMC#29 from NOAA-EMC/feature/manage_externals

Issue NOAA-EMC#3 - Introduce manage_externals as replacement for checkout.sh
jkhender · Mar 11, 2020 · 057b2a8 · 057b2a8
2 parents 0377d20 + 622167d
commit 057b2a8
Show file tree

Hide file tree

Showing 25 changed files with 129 additions and 430 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,16 @@
+# Ignore all compiled files
+*.pyc
+*.o
+*.mod
+
+# Ignore exec folder
+exec/
+
+# Ignore sorc folders from externals
+sorc/logs/
+sorc/fv3gfs.fd/
+sorc/gfs_post.fd/
+sorc/gsi.fd/
+sorc/ufs_utils.fd/
+sorc/gfs_wafs.fd/
+sorc/verif-global.fd/
diff --git a/Externals.cfg b/Externals.cfg
@@ -0,0 +1,46 @@
+# External sub-modules of global-workflow
+
+[NEMSfv3gfs]
+tag = gfs.v16_PhysicsUpdate
+local_path = sorc/fv3gfs.fd
+repo_url = ssh://vlab.ncep.noaa.gov:29418/NEMSfv3gfs
+protocol = git
+required = True
+
+[GSI]
+hash = cb8f69d8
+local_path = sorc/gsi.fd
+repo_url = ssh://vlab.ncep.noaa.gov:29418/ProdGSI
+protocol = git
+required = True
+
+[EMC_post]
+hash = ba7e59b2
+local_path = sorc/gfs_post.fd
+repo_url = https://github.com/NOAA-EMC/EMC_post.git
+protocol = git
+required = True
+
+[UFS_UTILS]
+tag = v1.1.0
+local_path = sorc/ufs_utils.fd
+repo_url = https://github.com/NOAA-EMC/UFS_UTILS.git
+protocol = git
+required = True
+
+[EMC_verif-global]
+tag = verif_global_v1.5.0
+local_path = sorc/verif-global.fd
+repo_url = ssh://vlab.ncep.noaa.gov:29418/EMC_verif-global
+protocol = git
+required = True
+
+[EMC_gfs_wafs]
+tag = gfs_wafs.v5.0.11
+local_path = sorc/gfs_wafs.fd
+repo_url = https://github.com/NOAA-EMC/EMC_gfs_wafs.git
+protocol = git
+required = False
+
+[externals_description]
+schema_version = 1.0.0
diff --git a/README.md b/README.md
@@ -0,0 +1,49 @@
+# global-workflow
+Global Superstructure/Workflow currently supporting the Finite-Volume on a Cubed-Sphere Global Forecast System (FV3GFS)
+
+The global-workflow depends on the following prerequisities to be available on the system:
+
+* workload management platform / scheduler - LSF or SLURM
+* workflow manager - ROCOTO (https://github.com/christopherwharrop/rocoto)
+* modules - NCEPLIBS (various), esmf v8.0.0bs48, hdf5, intel/ips v18, impi v18, wgrib2, netcdf v4.7.0, hpss, gempak (see module files under /modulefiles for additional details)
+* manage_externals - A utility from ESMCI to checkout external dependencies. Manage_externals can be obtained at the following address and should be in the users PATH: https://github.com/ESMCI/manage_externals
+
+The global-workflow current supports the following machines:
+
+* WCOSS-Dell
+* WCOSS-Cray
+* Hera
+
+## Build global-workflow:
+
+### 1. Check out components
+
+The global-workflow uses the manage_externals utility to handle checking out its components. The manic-v1.1.8 manage_externals tag is supported. The manage_externals utility will be replacing the current checkout.sh script.
+
+Run manage_externals (checkout_externals) while at top of clone:
+
+```
+$ checkout_externals -e Externals.cfg
+```
+
+If checkout_externals is not in your $PATH then use full path to it:
+
+* WCOSS-Dell: /gpfs/dell2/emc/modeling/noscrub/emc.glopara/git/manage_externals/manic-v1.1.8/checkout_externals
+* WCOSS-Cray: /gpfs/hps3/emc/global/noscrub/emc.glopara/git/manage_externals/manic-v1.1.8/checkout_externals
+* Hera: /scratch1/NCEPDEV/global/glopara/git/manage_externals/manic-v1.1.8/checkout_externals
+
+### 2. Build components
+
+While in /sorc folder:
+```
+$ sh build_all.sh
+```
+
+### 3. Link components
+
+While in /sorc folder:
+```
+$ sh link_fv3gfs.sh emc $MACHINE
+```
+
+...where $MACHINE is "dell", "cray", or "hera".
diff --git a/modulefiles/module_nemsutil.hera b/modulefiles/module_nemsutil.hera
diff --git a/modulefiles/module_nemsutil.wcoss b/modulefiles/module_nemsutil.wcoss
diff --git a/modulefiles/module_nemsutil.wcoss_cray b/modulefiles/module_nemsutil.wcoss_cray
diff --git a/modulefiles/module_nemsutil.wcoss_cray_userlib b/modulefiles/module_nemsutil.wcoss_cray_userlib
diff --git a/modulefiles/module_nemsutil.wcoss_dell_p3 b/modulefiles/module_nemsutil.wcoss_dell_p3
diff --git a/modulefiles/modulefile.grib_util.wcoss b/modulefiles/modulefile.grib_util.wcoss
diff --git a/modulefiles/modulefile.grib_util.wcoss_cray b/modulefiles/modulefile.grib_util.wcoss_cray
diff --git a/modulefiles/modulefile.grib_util.wcoss_cray_userlib b/modulefiles/modulefile.grib_util.wcoss_cray_userlib
diff --git a/modulefiles/modulefile.grib_util.wcoss_dell_p3 b/modulefiles/modulefile.grib_util.wcoss_dell_p3
diff --git a/modulefiles/modulefile.prod_util.wcoss_cray b/modulefiles/modulefile.prod_util.wcoss_cray
diff --git a/modulefiles/modulefile.prod_util.wcoss_cray_userlib b/modulefiles/modulefile.prod_util.wcoss_cray_userlib
diff --git a/modulefiles/modulefile.prod_util.wcoss_dell_p3 b/modulefiles/modulefile.prod_util.wcoss_dell_p3
diff --git a/modulefiles/modulefile.wgrib2.wcoss b/modulefiles/modulefile.wgrib2.wcoss
diff --git a/modulefiles/modulefile.wgrib2.wcoss_cray b/modulefiles/modulefile.wgrib2.wcoss_cray
diff --git a/modulefiles/modulefile.wgrib2.wcoss_cray_userlib b/modulefiles/modulefile.wgrib2.wcoss_cray_userlib
diff --git a/modulefiles/modulefile.wgrib2.wcoss_dell_p3 b/modulefiles/modulefile.wgrib2.wcoss_dell_p3