Feature 767 ext dependencies doc update (#866)

Co-authored-by: George McCabe <[email protected]>

docs/Users_Guide/installation.rst

@@ -38,7 +38,16 @@ The following software is required to run METplus Wrappers:
 
 -  MET version 10.0 or above
 
-If running plot wrappers, cartopy and pandas packages are required
+If running use cases that use Python embedding, MET must be installed
+with python enabled and the following Python packages installed:
+
+- xarray
+
+- numpy
+
+- pandas
+
+- netCDF4
 
 Some of the wrappers have additional dependencies to run.
 

docs/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding.py

@@ -50,11 +50,20 @@
 
 ##############################################################################
 # MET Configuration
-# ---------------------
+# -----------------
 #
 # None. No MET configuration file for ASCII2NC is used in this case.
 #
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_point.py
+#
+# `read_ascii_point.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_point.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding_user_py.py

@@ -53,11 +53,20 @@
 
 ##############################################################################
 # MET Configuration
-# ---------------------
+# -----------------
 #
 # None. No MET configuration file for ASCII2NC is used in this case.
 #
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_point.py
+#
+# `read_ascii_point.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_point.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/CyclonePlotter/CyclonePlotter.py

@@ -21,6 +21,16 @@
 #  No datasets are required for running this use case.  Only output from
 #  running the MET Tool tc-pairs or the METplus tc pairs wrapper is required.
 
+##############################################################################
+# External Dependencies
+# ---------------------
+#
+# You will need to use a version of Python 3.6+ that has the following packages installed:
+#
+# * cartopy
+# * matplotlib
+#
+
 ##############################################################################
 # METplus Components
 # ------------------

docs/use_cases/met_tool_wrapper/EnsembleStat/EnsembleStat_python_embedding.py

@@ -55,7 +55,7 @@
 
 ##############################################################################
 # MET Configuration
-# ---------------------
+# -----------------
 #
 #
 # METplus sets environment variables based on user settings in the METplus configuration file. 
@@ -71,6 +71,15 @@
 # .. highlight:: bash
 # .. literalinclude:: ../../../../parm/met_config/EnsembleStatConfig_wrapped
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py
+#
+# `read_ascii_numpy.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_numpy.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/GridStat/GridStat_python_embedding.py

@@ -23,6 +23,7 @@
 # | This tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See `Running METplus`_ section for more information.
 # |
 
+
 ##############################################################################
 # METplus Components
 # ------------------
@@ -66,6 +67,15 @@
 # .. highlight:: bash
 # .. literalinclude:: ../../../../parm/met_config/GridStatConfig_wrapped
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py
+#
+# `read_ascii_numpy.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_numpy.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/MODE/MODE_python_embedding.py

@@ -66,6 +66,15 @@
 # .. highlight:: bash
 # .. literalinclude:: ../../../../parm/met_config/MODEConfig_wrapped
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py
+#
+# `read_ascii_numpy.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_numpy.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/MTD/MTD_python_embedding.py

@@ -66,6 +66,15 @@
 # .. highlight:: bash
 # .. literalinclude:: ../../../../parm/met_config/MTDConfig_wrapped
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py
+#
+# `read_ascii_numpy.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_numpy.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/PlotDataPlane/PlotDataPlane_python_embedding.py

@@ -54,11 +54,20 @@
 
 ##############################################################################
 # MET Configuration
-# ---------------------
+# -----------------
 #
 # This tool does not use a MET configuration file.
 #
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py
+#
+# `read_ascii_numpy.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_numpy.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/PointStat/PointStat_python_embedding.py

@@ -72,6 +72,17 @@
 # .. highlight:: bash
 # .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the binary input data.
+# /parm/use_cases/met_tool_wrapper/PointStat/PointStat_python_embedding/read_NRL_binary.py
+#
+# .. highlight:: python
+# .. literalinclude:: ../../../../parm/use_cases/met_tool_wrapper/PointStat/PointStat_python_embedding/read_NRL_binary.py
+#
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/PyEmbedIngest/PyEmbedIngest.py

@@ -47,11 +47,20 @@
 
 ##############################################################################
 # MET Configuration
-# ---------------------
+# -----------------
 #
 # None. RegridDataPlane does not use configuration files.
 #
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py
+#
+# `read_ascii_numpy.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_numpy.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/PyEmbedIngest/PyEmbedIngest_multi_field_one_file.py

@@ -50,11 +50,20 @@
 
 ##############################################################################
 # MET Configuration
-# ---------------------
+# -----------------
 #
 # None. RegridDataPlane does not use configuration files.
 #
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py
+#
+# `read_ascii_numpy.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_numpy.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/RegridDataPlane/RegridDataPlane_python_embedding.py

@@ -52,11 +52,20 @@
 
 ##############################################################################
 # MET Configuration
-# ---------------------
+# -----------------
 #
 # None. RegridDataPlane does not use configuration files.
 #
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py
+#
+# `read_ascii_numpy.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_numpy.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/SeriesAnalysis/SeriesAnalysis_python_embedding.py

@@ -52,7 +52,7 @@
 
 ##############################################################################
 # MET Configuration
-# ---------------------
+# -----------------
 #
 # METplus sets environment variables based on user settings in the METplus configuration file. 
 # See :ref:`How METplus controls MET config file settings<metplus-control-met>` for more details. 
@@ -67,6 +67,15 @@
 # .. highlight:: bash
 # .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read the input data.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_numpy.py
+#
+# `read_ascii_numpy.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_numpy.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/met_tool_wrapper/StatAnalysis/StatAnalysis_python_embedding.py

@@ -77,6 +77,15 @@
 # .. highlight:: bash
 # .. literalinclude:: ../../../../parm/met_config/STATAnalysisConfig_wrapped
 
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case calls a Python script to read matched pair lines from an input source.
+# The Python script is stored in the MET repository: /path/to/MET/installation/share/met/python/read_ascii_mpr.py
+#
+# `read_ascii_mpr.py <https://github.com/dtcenter/MET/blob/develop/met/scripts/python/read_ascii_mpr.py>`_
+
 ##############################################################################
 # Running METplus
 # ---------------

docs/use_cases/model_applications/data_assimilation/StatAnalysis_fcstHAFS_obsPrepBufr_JEDI_IODA_interface.py

@@ -45,7 +45,6 @@
 # | The tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See `Running METplus`_ section for more information.
 # |
 
-
 ##############################################################################
 # METplus Components
 # ------------------
@@ -78,7 +77,7 @@
 
 ##############################################################################
 # MET Configuration
-# ---------------------
+# -----------------
 #
 # METplus sets environment variables based on user settings in the METplus configuration file. 
 # See :ref:`How METplus controls MET config file settings<metplus-control-met>` for more details. 

docs/use_cases/model_applications/marine_and_coastal/PlotDataPlane_obsHYCOM_coordTripolar.py

@@ -24,6 +24,21 @@
 # | **Data Source:** HYCOM model
 # |
 
+##############################################################################
+# External Dependencies
+# ---------------------
+#
+# You will need to use a version of Python 3.6+ that has the following packages installed:
+#
+# * xesmf
+#
+# If the version of Python used to compile MET did not have these libraries at the time of compilation, you will need to add these packages or create a new Python environment with these packages.
+#
+# If this is the case, you will need to set the MET_PYTHON_EXE environment variable to the path of the version of Python you want to use. If you want this version of Python to only apply to this use case, set it in the [user_env_vars] section of a METplus configuration file.:
+#
+#    [user_env_vars]
+#    MET_PYTHON_EXE = /path/to/python/with/required/packages/bin/python
+
 ##############################################################################
 # METplus Components
 # ------------------

docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByInit.py

@@ -33,6 +33,15 @@
 #  * Series-Analysis Observation dataset: GFS Analysis
 #
 
+##############################################################################
+# External Dependencies
+# ---------------------
+#
+# You will need to use a version of Python 3.6+ that has the following packages installed::
+#
+# * netCDF4
+#
+
 ##############################################################################
 # METplus Components
 # ------------------

docs/use_cases/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead.py

@@ -36,6 +36,15 @@
 #  * Series-Analysis Observation dataset: GFS Analysis
 #
 
+##############################################################################
+# External Dependencies
+# ---------------------
+#
+# You will need to use a version of Python 3.6+ that has the following packages installed::
+#
+# * netCDF4
+#
+
 ##############################################################################
 # METplus Components
 # ------------------