Feature 2588 install rewrite (#2791)

* updated first 3 sections * updated spacing * adding the Environment Variables to Run Script section * adding in the remainder of the google doc changes * trying to fix duplicate explicit target name issue * fixing required_external_libraries_to_build_met links * HDF4 testing double underscore * adding double underscores for HDF5 and HDF-EOS2 and changing library back * fixing HDF5 web link name * Added formatting, made minor edits, removed manual build instructions sections * Removed reference to sample-test-case which no longer exists * Resolving errors * Minor formatting change * Updated apptainer instructions, new version references * Formatting updates and removal of first person language * fixed code blocks * Resolving error * Removed first person references * Removed reference to met_directory_structure * updated bolding, removed end section * Changing X.Y.X references to X.Y.Z * updating thru Using the compile_MET_all.sh Script * fixing spacing for ATLAS web address * Fixed broken internal reference to installation due to typo * adding version numbers * fixing Recommended-Components MET * 3.4.2 section updates * fixing spacing * adding a period and more dropdown menus * fixing spacing * loose ends * removing space * removing bold * External Library handling in compile_MET_all.sh section updates * installation directory view * installation directory after * attempting to add figures via the web updating Executing the compile_MET_all.sh script section * fixing bolds, italics etc. * updating last half of doc * loose ends * loose ends * adding more dropdown menus * fixing dropdown menu and testing automatic version * testing automatic version * confirmed automatic version cannot be added to italics or code blocks * another round of updates * fixing indents * creating a table * fixing table * fixing table 2 * more loose end changes * more changes * hopefully final updates * trying a fancy new csv table * troubleshooting csv table * correcting table name * adding a grid table * fixing grid table * removing csv table * Per #2588, update to the environment variables table. * Delete docs/Users_Guide/environment_variables_table.csv * Per #2785, add new example installation files * updating small changes in the first half of the documentation * new dropdown menu and fixing some links * trying to fix line spacing in dropdown * take 2 fixing spacing * take 3 fix spacing * env var order * removing "s" * small changes * un capitalizing S * A few minor changes --------- Co-authored-by: j-opatz <jopatz@ucar.edu> Co-authored-by: Julie Prestopnik <jpresto@ucar.edu> Co-authored-by: j-opatz <59586397+j-opatz@users.noreply.github.com> Co-authored-by: John Halley Gotway <johnhg@ucar.edu>
dtcenter · Jan 22, 2024 · 50f228a · 50f228a
1 parent edeb415
commit 50f228a
Show file tree

Hide file tree

Showing 9 changed files with 738 additions and 366 deletions.
diff --git a/docs/Users_Guide/figure/installation_dir.png b/docs/Users_Guide/figure/installation_dir.png
diff --git a/docs/Users_Guide/figure/installation_dir_after.png b/docs/Users_Guide/figure/installation_dir_after.png
diff --git a/docs/Users_Guide/installation.rst b/docs/Users_Guide/installation.rst
diff --git a/docs/Users_Guide/reformat_grid.rst b/docs/Users_Guide/reformat_grid.rst
@@ -215,7 +215,7 @@ Each NetCDF file generated by the Pcp-Combine tool contains the dimensions and v
 Regrid-Data-Plane Tool
 ======================
 
-This section contains a description of running the Regrid-Data-Plane tool. This tool may be run to read data from any gridded file MET supports, interpolate to a user-specified grid, and writes the field(s) out in NetCDF format. The user may specify the method of interpolation used for regridding as well as which fields to regrid. This tool is particularly useful when dealing with GRIB2 and NetCDF input files that need to be regridded. For GRIB1 files, it has also been tested for compatibility with the copygb regridding utility mentioned in :numref:`Installation-of-optional`.
+This section contains a description of running the Regrid-Data-Plane tool. This tool may be run to read data from any gridded file MET supports, interpolate to a user-specified grid, and writes the field(s) out in NetCDF format. The user may specify the method of interpolation used for regridding as well as which fields to regrid. This tool is particularly useful when dealing with GRIB2 and NetCDF input files that need to be regridded. For GRIB1 files, it has also been tested for compatibility with the copygb regridding utility mentioned in :numref:`suggested_external_utiliites`.
 
 regrid_data_plane Usage
 -----------------------

diff --git a/docs/Users_Guide/reformat_point.rst b/docs/Users_Guide/reformat_point.rst
@@ -94,7 +94,7 @@ In this example, the PB2NC tool will process the input **sample_pb.blk** file ap
 pb2nc Configuration File
 ------------------------
 
-The default configuration file for the PB2NC tool named **PB2NCConfig_default** can be found in the installed *share/met/config* directory. The version used for the example run in :numref:`Sample test cases` is available in *scripts/config*. It is recommended that users make a copy of configuration files prior to modifying their contents.
+The default configuration file for the PB2NC tool named **PB2NCConfig_default** can be found in the installed *share/met/config* directory. The version used for the installation test cases is available in *scripts/config*. It is recommended that users make a copy of configuration files prior to modifying their contents.
 
 Note that environment variables may be used when editing configuration files, as described in the :numref:`config_env_vars`.
 

diff --git a/docs/Users_Guide/tc-dland.rst b/docs/Users_Guide/tc-dland.rst
@@ -16,7 +16,7 @@ Input/Output Format
 
 The input for the TC-dland tool is a file containing the longitude (degrees east) and latitude (degrees north) of all the coastlines and islands considered to be a significant landmass. The default input is to use all three land data files (**aland.dat, shland.dat, wland.dat**) found in the installed *share/met/tc_data/* directory. The use of all three files produces a global land data file. The **aland.dat** file contains the longitude and latitude distinctions used by NHC for the Atlantic and eastern North Pacific basins, the **shland.dat** contains longitude and latitude distinctions for the Southern Hemisphere (south Pacific and South Indian Ocean), and the **wland.dat** contains the remainder of the Northern Hemisphere (western North Pacific and North Indian Ocean). Users may supply their own input file in order to refine the definition of coastlines and a significant landmass.
 
-The output file from TC-dland is a NetCDF format file containing a gridded field representing the distance to the nearest coastline or island, as specified in the input file. This file is used in the TC-Pairs tool to compute the distance from land for each track point in the adeck and bdeck. As noted in :numref:`met_directory_structure`, precomputed distance to land (NetCDF output from TC-dland) files are available in the release. In the installed *share/met/tc_data* directory: 
+The output file from TC-dland is a NetCDF format file containing a gridded field representing the distance to the nearest coastline or island, as specified in the input file. This file is used in the TC-Pairs tool to compute the distance from land for each track point in the adeck and bdeck. The precomputed distance to land (NetCDF output from TC-dland) files are available in the release. In the installed *share/met/tc_data* directory: 
 
 **dland_nw_hem_tenth_degree.nc:** TC-dland output from **aland.dat** using a 1/10th degree grid
 

diff --git a/...stallation/config/install_met_env.generic → ...lation/config/install_met_env.generic_gnu b/...stallation/config/install_met_env.generic → ...lation/config/install_met_env.generic_gnu
@@ -47,6 +47,8 @@ export MAKE_ARGS="-j 5"
 # need to update the paths to the appropriate location.
 #export EXTERNAL_LIBS=${TEST_BASE}/external_libs
 #export MET_PROJ=${EXTERNAL_LIBS}
+#export TIFF_INCLUDE_DIR=${EXTERNAL_LIBS}/include
+#export TIFF_LIB_DIR=${EXTERNAL_LIBS}/lib
 #export SQLITE_INCLUDE_DIR=${EXTERNAL_LIBS}/include
 #export SQLITE_LIB_DIR=${EXTERNAL_LIBS}/lib
 #export MET_GSL=${EXTERNAL_LIBS}

diff --git a/internal/scripts/installation/config/install_met_env.generic_intel_non-oneapi b/internal/scripts/installation/config/install_met_env.generic_intel_non-oneapi
@@ -0,0 +1,86 @@
+# Find the directory this script is called from
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+# Required
+# Directory that is the root of the compile
+export TEST_BASE=${DIR}
+
+# Required
+# Format is compiler_version (e.g. gnu_8.3.0)
+# Compiler options = gnu, intel, ics, ips, PrgEnv-intel, or pgi
+# Version is used for gnu in compilation of BUFRLIB and HDF5
+export COMPILER=intel_2022.1.2
+
+# Set the values for the compilers
+export FC=ifort
+export F77=ifort
+export F90=ifort
+export CC=icc
+export CXX=icpc
+
+# Required
+# Root directory for creating/untaring met source code - usually same as TEST_BASE
+export MET_SUBDIR=${TEST_BASE}
+
+# Required
+# The name of the met tarbal usually downloaded with version from dtcenter.org and includes a version
+#  example - v11.1.0.tar.gz
+export MET_TARBALL=v12.0.0.tar.gz
+
+# Required
+# Specify if machine useds modules for loading software
+export USE_MODULES=FALSE
+
+# Root directory of your python install, containing the bin, include, lib, and share directories
+export MET_PYTHON=`python3-config --prefix`
+
+# Python ldflags created using python3-config
+export MET_PYTHON_LD=`python3-config --ldflags --embed`
+
+# Python cflags created using python3-config
+export MET_PYTHON_CC=`python3-config --cflags`
+
+# Use MAKE_ARGS to sped up the compilation of the external libaries and/or MET
+# MAKE_ARGS can be set "-j #" where # is replaced with the number of
+# cores to use (as an integer) or to simply "-j" to use all available cores.
+# Recommend setting to "-j 5" as some users have experienced problems with
+# higher values or no # specified.
+export MAKE_ARGS="-j 5"
+
+# If users have already installed these libraries and would like to make use of
+# them, uncomment out the export statements. If those pre-existing libraries are
+# in the external_libs directory, no further edits are needed; however, users
+# that have the pre-existing libraries not in the external_libs directory will
+# need to update the paths to the appropriate location.
+#export EXTERNAL_LIBS=${TEST_BASE}/external_libs
+#export MET_PROJ=${EXTERNAL_LIBS}
+#export TIFF_INCLUDE_DIR=${EXTERNAL_LIBS}/include
+#export TIFF_LIB_DIR=${EXTERNAL_LIBS}/lib
+#export SQLITE_INCLUDE_DIR=${EXTERNAL_LIBS}/include
+#export SQLITE_LIB_DIR=${EXTERNAL_LIBS}/lib
+#export MET_GSL=${EXTERNAL_LIBS}
+#export MET_BUFRLIB=${EXTERNAL_LIBS}/lib
+#export BUFRLIB_NAME=-lbufr_4
+#export LIB_JASPER=${EXTERNAL_LIBS}/lib
+#export LIB_LIBPNG=${EXTERNAL_LIBS}/lib
+#export LIB_Z=${EXTERNAL_LIBS}/lib
+#export MET_GRIB2CLIB=${EXTERNAL_LIBS}/lib
+#export MET_GRIB2CINC=${EXTERNAL_LIBS}/include
+#export GRIB2CLIB_NAME=-lg2c
+#export MET_HDF5=${EXTERNAL_LIBS}
+#export MET_NETCDF=${EXTERNAL_LIBS}
+#export MET_ECKIT==${EXTERNAL_LIBS}
+#export MET_ATLAS==${EXTERNAL_LIBS}
+
+# The optional libraries ecKit and atlas offer support for unstructured
+# grids. The optional libraries HDF4, HDFEOS, FREETYPE, and CAIRO are
+# used for the following, not widely used tools, MODIS-Regrid,
+# lidar2nc, and MODE Graphics. To enable building of these libraries,
+# set the compile flags for the library (e.g. COMPILE_ECKIT, COMPILE_ATLAS,
+# COMPILE_HDF, COMPILE_HDFEOS) to any value in the environment config
+# file. If these libraries have already been installed and don't need
+# to be reinstalled, please supply values for the following environment
+# variables in the input environment configuration file
+# (install_met_env.<machine_name>): MET_ECKIT, MET_ATLAS, MET_HDF,
+# MET_HDFEOS, MET_FREETYPEINC, MET_FREETYPELIB, MET_CAIROINC,
+# MET_CAIROLIB.
diff --git a/internal/scripts/installation/config/install_met_env.generic_intel_oneapi b/internal/scripts/installation/config/install_met_env.generic_intel_oneapi
@@ -0,0 +1,86 @@
+# Find the directory this script is called from
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+# Required
+# Directory that is the root of the compile
+export TEST_BASE=${DIR}
+
+# Required
+# Format is compiler_version (e.g. gnu_8.3.0)
+# Compiler options = gnu, intel, ics, ips, PrgEnv-intel, or pgi
+# Version is used for gnu in compilation of BUFRLIB and HDF5
+export COMPILER=intel-oneapi_2023.0.0
+
+# Set the values for the compilers
+export FC=ifx
+export F77=ifx
+export F90=ifx
+export CC=icx
+export CXX=icpx
+
+# Required
+# Root directory for creating/untaring met source code - usually same as TEST_BASE
+export MET_SUBDIR=${TEST_BASE}
+
+# Required
+# The name of the met tarbal usually downloaded with version from dtcenter.org and includes a version
+#  example - v12.0.0.tar.gz
+export MET_TARBALL=v12.0.0.tar.gz
+
+# Required
+# Specify if machine useds modules for loading software
+export USE_MODULES=FALSE
+
+# Root directory of your python install, containing the bin, include, lib, and share directories
+export MET_PYTHON=`python3-config --prefix`
+
+# Python ldflags created using python3-config
+export MET_PYTHON_LD=`python3-config --ldflags --embed`
+
+# Python cflags created using python3-config
+export MET_PYTHON_CC=`python3-config --cflags`
+
+# Use MAKE_ARGS to sped up the compilation of the external libaries and/or MET
+# MAKE_ARGS can be set "-j #" where # is replaced with the number of
+# cores to use (as an integer) or to simply "-j" to use all available cores.
+# Recommend setting to "-j 5" as some users have experienced problems with
+# higher values or no # specified.
+export MAKE_ARGS="-j 5"
+
+# If users have already installed these libraries and would like to make use of
+# them, uncomment out the export statements. If those pre-existing libraries are
+# in the external_libs directory, no further edits are needed; however, users
+# that have the pre-existing libraries not in the external_libs directory will
+# need to update the paths to the appropriate location.
+#export EXTERNAL_LIBS=${TEST_BASE}/external_libs
+#export MET_PROJ=${EXTERNAL_LIBS}
+#export TIFF_INCLUDE_DIR=${EXTERNAL_LIBS}/include
+#export TIFF_LIB_DIR=${EXTERNAL_LIBS}/lib
+#export SQLITE_INCLUDE_DIR=${EXTERNAL_LIBS}/include
+#export SQLITE_LIB_DIR=${EXTERNAL_LIBS}/lib
+#export MET_GSL=${EXTERNAL_LIBS}
+#export MET_BUFRLIB=${EXTERNAL_LIBS}/lib
+#export BUFRLIB_NAME=-lbufr_4
+#export LIB_JASPER=${EXTERNAL_LIBS}/lib
+#export LIB_LIBPNG=${EXTERNAL_LIBS}/lib
+#export LIB_Z=${EXTERNAL_LIBS}/lib
+#export MET_GRIB2CLIB=${EXTERNAL_LIBS}/lib
+#export MET_GRIB2CINC=${EXTERNAL_LIBS}/include
+#export GRIB2CLIB_NAME=-lg2c
+#export MET_HDF5=${EXTERNAL_LIBS}
+#export MET_NETCDF=${EXTERNAL_LIBS}
+#export MET_ECKIT==${EXTERNAL_LIBS}
+#export MET_ATLAS==${EXTERNAL_LIBS}
+
+# The optional libraries ecKit and atlas offer support for unstructured
+# grids. The optional libraries HDF4, HDFEOS, FREETYPE, and CAIRO are
+# used for the following, not widely used tools, MODIS-Regrid,
+# lidar2nc, and MODE Graphics. To enable building of these libraries,
+# set the compile flags for the library (e.g. COMPILE_ECKIT, COMPILE_ATLAS,
+# COMPILE_HDF, COMPILE_HDFEOS) to any value in the environment config
+# file. If these libraries have already been installed and don't need
+# to be reinstalled, please supply values for the following environment
+# variables in the input environment configuration file
+# (install_met_env.<machine_name>): MET_ECKIT, MET_ATLAS, MET_HDF,
+# MET_HDFEOS, MET_FREETYPEINC, MET_FREETYPELIB, MET_CAIROINC,
+# MET_CAIROLIB.