From 394e6484d61e115497f228f4fe83d7b1c43c6b05 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 11 Jan 2024 13:29:46 -0700 Subject: [PATCH 01/47] creating test dropdown menus --- docs/Users_Guide/overview.rst | 40 +++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index c60511ec1c..8df0bea863 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -85,6 +85,46 @@ METplus Wrappers configuration files. Some Python wrappers do not correspond to a particular MET tool, but wrap utilities to extend METplus functionality. +.. dropdown:: Python 3.10.4+ + + METplus Component: + METplus wrappers, + METcalcpy, + METplotpy, + METdataio + +.. dropdown:: cartopy + + Version: >=0.21.1 + + METplus Component: + METplus wrappers, + METcalcpy, + METplotpy + + Source: + https://scitools.org.uk/cartopy/docs/latest/ + + Description: + Designed for + geospatial data + processing in + order to produce + maps and other + geospatial data + analyses + + Use Cases: + + `TCGen: Genesis Density Function (GDF) + and Track Density Function (TDF) + (cartopy) + <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + `CyclonePlotter: Extra-TC Tracker + and Plotting Capabilities + (cartopy) + <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ + .. _python_requirements_table: METplus Components Python Requirements From a1a83b8a8c0503d12b2e9b019b6035e7944679f4 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 11 Jan 2024 13:39:49 -0700 Subject: [PATCH 02/47] fixing warnings --- docs/Users_Guide/overview.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 8df0bea863..b5603b5a1f 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -115,7 +115,6 @@ METplus functionality. analyses Use Cases: - `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) (cartopy) From 64a8222f278208f551d992facd4d8c7409077931 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 11 Jan 2024 13:46:28 -0700 Subject: [PATCH 03/47] fixing warnings --- docs/Users_Guide/overview.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index b5603b5a1f..05dc000451 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -117,11 +117,9 @@ METplus functionality. Use Cases: `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) - (cartopy) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities - (cartopy) <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ .. _python_requirements_table: From 5c73ac2a9f5180fd20fa95831f204528de589fe4 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 11 Jan 2024 13:50:32 -0700 Subject: [PATCH 04/47] fixing warnings 3 --- docs/Users_Guide/overview.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 05dc000451..ab09ad42f4 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -118,8 +118,7 @@ METplus functionality. `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - `CyclonePlotter: Extra-TC Tracker - and Plotting Capabilities + `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ .. _python_requirements_table: From ac8cc2e4a8892d6fd873db17c5f0617bb4b78cd3 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 11 Jan 2024 13:55:33 -0700 Subject: [PATCH 05/47] fixing warnings 4 --- docs/Users_Guide/overview.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index ab09ad42f4..ad18f9bae7 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -115,11 +115,8 @@ METplus functionality. analyses Use Cases: - `TCGen: Genesis Density Function (GDF) - and Track Density Function (TDF) - <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities - <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ + `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ .. _python_requirements_table: From 1b779d6b6fca5a4592be428d1bbff0686e1b9917 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Thu, 11 Jan 2024 15:20:14 -0700 Subject: [PATCH 06/47] Attempt to fix documentation errors --- docs/Users_Guide/overview.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index ad18f9bae7..947644ca55 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -487,17 +487,17 @@ METplus Components Python Requirements Cloud Fractions with Neighborhood and Probabilities (pygrib) - <../generated/model_applications/clouds/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.html>`_ :raw-html:`
` + <../generated/model_applications/clouds/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.html>`__ :raw-html:`
` `GridStat: Cloud Fractions with Neighborhood and Probabilities (pygrib) - <../generated/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac.html>`_ :raw-html:`
` + <../generated/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac.html>`__ :raw-html:`
` `GridStat: Cloud Fractions with Neighborhood and Probabilities (pygrib) - <../generated/model_applications/clouds/GridStat_fcstMPAS_obsMERRA2_lowAndTotalCloudFrac.html>`_ + <../generated/model_applications/clouds/GridStat_fcstMPAS_obsMERRA2_lowAndTotalCloudFrac.html>`__ * - pylab - - METplus wrappers From 36427119f86755625a0b3d52b06e8d76e03cf71f Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Fri, 12 Jan 2024 10:37:13 -0700 Subject: [PATCH 07/47] adding 2 more test dropdowns please note. There is still a message about WARNING: Duplicate explicit target name: "gridstat: cloud fractions with neighborhood and probabilities (pygrib)". John O will fix this. I should not touch it. --- docs/Users_Guide/overview.rst | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 947644ca55..fa1b958ea5 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -85,6 +85,8 @@ METplus Wrappers configuration files. Some Python wrappers do not correspond to a particular MET tool, but wrap utilities to extend METplus functionality. +**Testing dropdown menus:** + .. dropdown:: Python 3.10.4+ METplus Component: @@ -95,7 +97,8 @@ METplus functionality. .. dropdown:: cartopy - Version: >=0.21.1 + Version: + >=0.21.1 METplus Component: METplus wrappers, @@ -115,9 +118,37 @@ METplus functionality. analyses Use Cases: - `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ +.. dropdown:: cfgrib + + METplus Component: + METplus wrappers + + Source: + https://pypi.org/project/cfgrib/ + + Description: + map GRIB files to the NetCDF Common Data Model following the CF Convention using ecCodes + + Use Cases: + `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields (cfgrib)<../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ + + +.. dropdown:: cmocean + + METplus Component: + METcalcpy, + METplotpy + + Source: + https://pypi.org/project/cmocean/ + + Use Cases: + contains colormaps for commonly-used oceanographic variables + + .. _python_requirements_table: METplus Components Python Requirements From d59525ed8a889ec7184111ab0e0468adbefd9298 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Fri, 12 Jan 2024 10:45:56 -0700 Subject: [PATCH 08/47] fixing spacing --- docs/Users_Guide/overview.rst | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index fa1b958ea5..379f6ad0bf 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -109,17 +109,11 @@ METplus functionality. https://scitools.org.uk/cartopy/docs/latest/ Description: - Designed for - geospatial data - processing in - order to produce - maps and other - geospatial data - analyses + Designed for geospatial data processing in order to produce maps and other geospatial data analyses Use Cases: `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ + `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ .. dropdown:: cfgrib From c448e1904ee5de035a5c3787d16b84cad3490985 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Fri, 12 Jan 2024 10:57:06 -0700 Subject: [PATCH 09/47] trying to fix link --- docs/Users_Guide/overview.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 379f6ad0bf..5a5f229ab4 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -127,8 +127,7 @@ METplus functionality. map GRIB files to the NetCDF Common Data Model following the CF Convention using ecCodes Use Cases: - `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields (cfgrib)<../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ - + `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields (cfgrib) <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ .. dropdown:: cmocean From 8409e4b2b587e2968cadebdc65e1e7684dbcb79f Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Fri, 12 Jan 2024 11:05:59 -0700 Subject: [PATCH 10/47] take 2 --- docs/Users_Guide/overview.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 5a5f229ab4..d71a175d57 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -127,7 +127,8 @@ METplus functionality. map GRIB files to the NetCDF Common Data Model following the CF Convention using ecCodes Use Cases: - `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields (cfgrib) <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ + `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields (cfgrib) + <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ .. dropdown:: cmocean From f484f9bb9aef625bad8bdf15d392ea8add097663 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Fri, 12 Jan 2024 11:30:43 -0700 Subject: [PATCH 11/47] Removing double underscores added earlier --- docs/Users_Guide/overview.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index d71a175d57..23b59122f6 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -512,17 +512,17 @@ METplus Components Python Requirements Cloud Fractions with Neighborhood and Probabilities (pygrib) - <../generated/model_applications/clouds/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.html>`__ :raw-html:`
` + <../generated/model_applications/clouds/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.html>`_ :raw-html:`
` `GridStat: Cloud Fractions with Neighborhood and Probabilities (pygrib) - <../generated/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac.html>`__ :raw-html:`
` + <../generated/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac.html>`_ :raw-html:`
` `GridStat: Cloud Fractions with Neighborhood and Probabilities (pygrib) - <../generated/model_applications/clouds/GridStat_fcstMPAS_obsMERRA2_lowAndTotalCloudFrac.html>`__ + <../generated/model_applications/clouds/GridStat_fcstMPAS_obsMERRA2_lowAndTotalCloudFrac.html>`_ * - pylab - - METplus wrappers From 7df30181f3a880423ef4e2b7c2dbb9434ae73fc1 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Fri, 12 Jan 2024 11:50:45 -0700 Subject: [PATCH 12/47] moving dropdown menus --- docs/Users_Guide/overview.rst | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 23b59122f6..bf8d61586d 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -85,6 +85,11 @@ METplus Wrappers configuration files. Some Python wrappers do not correspond to a particular MET tool, but wrap utilities to extend METplus functionality. +.. _python_requirements_table: + +METplus Components Python Requirements +====================================== + **Testing dropdown menus:** .. dropdown:: Python 3.10.4+ @@ -117,6 +122,9 @@ METplus functionality. .. dropdown:: cfgrib + Version: + No version specific version specified + METplus Component: METplus wrappers @@ -132,6 +140,9 @@ METplus functionality. .. dropdown:: cmocean + Version: + No version specific version specified + METplus Component: METcalcpy, METplotpy @@ -139,15 +150,10 @@ METplus functionality. Source: https://pypi.org/project/cmocean/ - Use Cases: + Description: contains colormaps for commonly-used oceanographic variables -.. _python_requirements_table: - -METplus Components Python Requirements -====================================== - .. Number of characters per line: Name - no more that 13 characters Version - no more than 6 characters From 0f233e34b3b803a9f869b96e9cf285cf90103656 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Fri, 12 Jan 2024 12:41:06 -0700 Subject: [PATCH 13/47] Adding version to dropdown menu title --- docs/Users_Guide/overview.rst | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index bf8d61586d..4df941e9d8 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -100,10 +100,7 @@ METplus Components Python Requirements METplotpy, METdataio -.. dropdown:: cartopy - - Version: - >=0.21.1 +.. dropdown:: cartopy >=0.21.1 METplus Component: METplus wrappers, @@ -122,9 +119,6 @@ METplus Components Python Requirements .. dropdown:: cfgrib - Version: - No version specific version specified - METplus Component: METplus wrappers @@ -139,9 +133,6 @@ METplus Components Python Requirements <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ .. dropdown:: cmocean - - Version: - No version specific version specified METplus Component: METcalcpy, From d4075bbfb776b091f649773db846d680833191f4 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Wed, 17 Jan 2024 13:50:19 -0700 Subject: [PATCH 14/47] fixing spacing --- docs/Users_Guide/overview.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 4df941e9d8..3b9b710428 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -95,17 +95,17 @@ METplus Components Python Requirements .. dropdown:: Python 3.10.4+ METplus Component: - METplus wrappers, - METcalcpy, - METplotpy, - METdataio + | METplus wrappers, + | METcalcpy, + | METplotpy, + | METdataio .. dropdown:: cartopy >=0.21.1 METplus Component: - METplus wrappers, - METcalcpy, - METplotpy + | METplus wrappers, + | METcalcpy, + | METplotpy Source: https://scitools.org.uk/cartopy/docs/latest/ @@ -135,8 +135,8 @@ METplus Components Python Requirements .. dropdown:: cmocean METplus Component: - METcalcpy, - METplotpy + | METcalcpy, + | METplotpy Source: https://pypi.org/project/cmocean/ From 6265441e219407fe5fecfe0ef12b749759cdb8b6 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Wed, 17 Jan 2024 14:19:52 -0700 Subject: [PATCH 15/47] dropdowns date util, eofs, h5py --- docs/Users_Guide/overview.rst | 60 +++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 3b9b710428..b123346374 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -144,6 +144,66 @@ METplus Components Python Requirements Description: contains colormaps for commonly-used oceanographic variables +NEW SECTION + +.. dropdown:: dateutil >=2.8.2 + METplus Component: + METplus wrappers + + Source: + https://github.com/dateutil/dateutil/releases + + Description: + provides powerful extensions to the standard datetime module + + Use Cases: + Most + +.. dropdown:: eofs + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://pypi.org/project/eofs/ + + Description: + empirical orthogonal functions analysis of spatial-temporal data + + Use Cases: + | `WeatherRegime Calculation: + RegridDataPlane, + PcpCombine, + and WeatherRegime python code + (eofs) + <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html>`_ :raw-html:`
` + | `WeatherRegime Calculation: + GFS and ERA RegridDataPlane, + PcpCombine, and + WeatherRegime python code + (eofs) + <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.html>`_ + +.. dropdown:: h5py + + METplus Component: + METplus wrappers + + Source: + https://github.com/h5py/h5py + + Description: + Pythonic interface to the HDF5 binary data format + +Use Case: + `PCPCombine: + Python Embedding Use Case + (h5py) + <../generated/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.html>`_ + +END NEW SECTION .. Number of characters per line: Name - no more that 13 characters From d56dfa4edb599c11d5bdbf1c6af7bcdbdbc6381a Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Wed, 17 Jan 2024 14:27:21 -0700 Subject: [PATCH 16/47] fixing formatting --- docs/Users_Guide/overview.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index b123346374..579b387094 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -147,6 +147,7 @@ METplus Components Python Requirements NEW SECTION .. dropdown:: dateutil >=2.8.2 + METplus Component: METplus wrappers @@ -179,7 +180,7 @@ NEW SECTION and WeatherRegime python code (eofs) <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html>`_ :raw-html:`
` - | `WeatherRegime Calculation: + | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code @@ -197,7 +198,7 @@ NEW SECTION Description: Pythonic interface to the HDF5 binary data format -Use Case: + Use Case: `PCPCombine: Python Embedding Use Case (h5py) From 8152673c3d67a05004a490fdc235e2e0124a8343 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Wed, 17 Jan 2024 15:13:27 -0700 Subject: [PATCH 17/47] fixing formatting --- docs/Users_Guide/overview.rst | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 579b387094..5cb88ed350 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -114,8 +114,8 @@ METplus Components Python Requirements Designed for geospatial data processing in order to produce maps and other geospatial data analyses Use Cases: - `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ + | `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + | `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ .. dropdown:: cfgrib @@ -129,7 +129,7 @@ METplus Components Python Requirements map GRIB files to the NetCDF Common Data Model following the CF Convention using ecCodes Use Cases: - `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields (cfgrib) + `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ .. dropdown:: cmocean @@ -174,18 +174,8 @@ NEW SECTION empirical orthogonal functions analysis of spatial-temporal data Use Cases: - | `WeatherRegime Calculation: - RegridDataPlane, - PcpCombine, - and WeatherRegime python code - (eofs) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html>`_ :raw-html:`
` - | `WeatherRegime Calculation: - GFS and ERA RegridDataPlane, - PcpCombine, and - WeatherRegime python code - (eofs) - <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.html>`_ + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html>`_ :raw-html:`
` + | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.html>`_ .. dropdown:: h5py @@ -199,10 +189,7 @@ NEW SECTION Pythonic interface to the HDF5 binary data format Use Case: - `PCPCombine: - Python Embedding Use Case - (h5py) - <../generated/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.html>`_ + `PCPCombine: Python Embedding Use Case <../generated/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.html>`_ END NEW SECTION From c8ced00cf6b9141a38b7c6f1e76d2c511ce24068 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Wed, 17 Jan 2024 15:42:26 -0700 Subject: [PATCH 18/47] Per #2463, adding template for future entries --- docs/Users_Guide/overview.rst | 203 ++++++++++++++++++++++++++++++++++ 1 file changed, 203 insertions(+) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index b2b2cffe3e..31bf4a8d63 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -191,6 +191,209 @@ NEW SECTION Use Case: `PCPCombine: Python Embedding Use Case <../generated/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.html>`_ +.. dropdown:: imutils >=0.5.4 + + METplus Component: + METplotpy + + Source: + https://pypi.org/project/imutils/ + + Description: + A series of convenience functions to make basic image processing functions such as translation, rotation, resizing, skeletonization, displaying Matplotlib images, sorting contours, detecting edges, and much more easier + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + +.. dropdown:: + + METplus Component: + + Source: + + Description: + + Use Case: + + + END NEW SECTION .. Number of characters per line: From 21560a2f67e283dc0d67df64869ab0dbb6191e65 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 18 Jan 2024 10:29:28 -0700 Subject: [PATCH 19/47] adding imageio, lxml & matplotlib --- docs/Users_Guide/overview.rst | 45 ++++++++++++++++++++++++----------- 1 file changed, 31 insertions(+), 14 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 31bf4a8d63..1c0e20c006 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -126,7 +126,7 @@ METplus Components Python Requirements https://pypi.org/project/cfgrib/ Description: - map GRIB files to the NetCDF Common Data Model following the CF Convention using ecCodes + Map GRIB files to the NetCDF Common Data Model following the CF Convention using ecCodes Use Cases: `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields @@ -142,9 +142,7 @@ METplus Components Python Requirements https://pypi.org/project/cmocean/ Description: - contains colormaps for commonly-used oceanographic variables - -NEW SECTION + Contains colormaps for commonly-used oceanographic variables .. dropdown:: dateutil >=2.8.2 @@ -155,7 +153,7 @@ NEW SECTION https://github.com/dateutil/dateutil/releases Description: - provides powerful extensions to the standard datetime module + Provides powerful extensions to the standard datetime module Use Cases: Most @@ -171,7 +169,7 @@ NEW SECTION https://pypi.org/project/eofs/ Description: - empirical orthogonal functions analysis of spatial-temporal data + Empirical orthogonal functions analysis of spatial-temporal data Use Cases: | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html>`_ :raw-html:`
` @@ -202,35 +200,54 @@ NEW SECTION Description: A series of convenience functions to make basic image processing functions such as translation, rotation, resizing, skeletonization, displaying Matplotlib images, sorting contours, detecting edges, and much more easier -.. dropdown:: +NEW SECTION + +.. dropdown:: imageio METplus Component: + | METcalcpy, + | METplotpy Source: + https://pypi.org/project/imageio/ Description: + Provides an easy interface to read and write a wide range of image data, including animated + images, volumetric data, and scientific formats - Use Case: - -.. dropdown:: +.. dropdown:: lxml >=4.9.1 METplus Component: + | METcalcpy, + | METplotpy, + | METdataio Source: + https://pypi.org/project/lxml/ Description: + A Pythonic binding for the C libraries libxml2 and libxslt - Use Case: - -.. dropdown:: +.. dropdown:: matplotlib >=3.6.3 METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy - Source: + Source: + https://matplotlib.org/stable/users/installing/index.html Description: + A comprehensive library for creating static, animated, and interactive visualizations Use Case: + | `UserScript: Make OMI plot from calculated MJO indices <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_OMI.html>`_ + | `TCGen: Genesis Density Function and Track Density Function <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + | `UserScript: Make a Phase Diagram plot from input RMM or OMI <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ + | `UserScript: Make OMI plot from calculated MJO indices <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_OMI.html>`_ + | `UserScript: Make RMM plots from calculated MJO indices <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_RMM.html>`_ + | `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ .. dropdown:: From 85126ec1c4f6a109421bd275b7ea74a8636383a7 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 18 Jan 2024 11:09:36 -0700 Subject: [PATCH 20/47] dropdown up to nc-time-axis --- docs/Users_Guide/overview.rst | 57 ++++++++++++++++++++++++++++++++--- 1 file changed, 52 insertions(+), 5 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 1c0e20c006..27ddbd5afd 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -200,8 +200,6 @@ METplus Components Python Requirements Description: A series of convenience functions to make basic image processing functions such as translation, rotation, resizing, skeletonization, displaying Matplotlib images, sorting contours, detecting edges, and much more easier -NEW SECTION - .. dropdown:: imageio METplus Component: @@ -245,29 +243,78 @@ NEW SECTION | `UserScript: Make OMI plot from calculated MJO indices <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_OMI.html>`_ | `TCGen: Genesis Density Function and Track Density Function <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ | `UserScript: Make a Phase Diagram plot from input RMM or OMI <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ - | `UserScript: Make OMI plot from calculated MJO indices <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_OMI.html>`_ + | `UserScript: Make OMI plot from calculated MJO indices <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_OMI.html>`_ | `UserScript: Make RMM plots from calculated MJO indices <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_RMM.html>`_ | `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ -.. dropdown:: +NEW SECTION + +.. dropdown:: metcalcpy METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy Source: + https://github.com/dtcenter/METcalcpy/releases Description: + A Python version of the statistics calculation functionality of METviewer, METexpress, + plotting packages in METplotpy and is a stand-alone package for any other application Use Case: + | `UserScript: Make a Hovmoeller plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ + | `UserScript: Make a Cross Spectra plot <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + | `Grid-Stat: Verification of TC forecasts against merged TDR data <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`_ + | `UserScript: Calculate the Difficulty Index <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ + | `UserScript: Make zonal and meridonial means <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_Stratosphere.html>`_ -.. dropdown:: +.. dropdown:: metplotpy METplus Component: + METplus wrappers + + Source: + https://github.com/dtcenter/METplotpy/releases + + Description: + Contains packages for plotting in METplus as stand-alone, or part of METplus use case, + METplus wrappers, METexpress, or METviewer + + Use Case: + | `UserScript: Make a Hovmoeller plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ + | `UserScript: Make a Cross Spectra plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`_ + | `UserScript: Calculate the Difficulty Index <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ + | `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + +.. dropdown:: metpy >=1.4.0 + + METplus Component: + METplus wrappers Source: + https://www.unidata.ucar.edu/software/metpy/ Description: + A collection of tools in Python for reading, visualizing, and performing calculations +with weather data Use Case: + `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ + +.. dropdown:: nc-time-axis -1.4 + + METplus Component: + | METplotpy + | stratosphere_diagnostics + + Source: + | https://github.com/SciTools/nc-time-axis + + Description: + Extension to cftime \**REQUIRES Python 3.7 + .. dropdown:: From 257eab92053c81e546a351d63ae31626feeb2647 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 18 Jan 2024 11:19:40 -0700 Subject: [PATCH 21/47] fixing spacing problems --- docs/Users_Guide/overview.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 27ddbd5afd..a4a1fa7cfa 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -247,8 +247,6 @@ METplus Components Python Requirements | `UserScript: Make RMM plots from calculated MJO indices <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_RMM.html>`_ | `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ -NEW SECTION - .. dropdown:: metcalcpy METplus Component: @@ -298,7 +296,7 @@ NEW SECTION Description: A collection of tools in Python for reading, visualizing, and performing calculations -with weather data + with weather data Use Case: `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ @@ -315,6 +313,7 @@ with weather data Description: Extension to cftime \**REQUIRES Python 3.7 +NEW SECTION .. dropdown:: From d672a4f99c9b7557cb93cd08ef83be9ae01e4058 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Thu, 18 Jan 2024 12:29:42 -0700 Subject: [PATCH 22/47] Fixing broken s2s links and other incorrect links --- docs/Users_Guide/overview.rst | 72 +++++++++++++++++------------------ 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index a4a1fa7cfa..cb7763c6c9 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -172,8 +172,8 @@ METplus Components Python Requirements Empirical orthogonal functions analysis of spatial-temporal data Use Cases: - | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html>`_ :raw-html:`
` - | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.html>`_ + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` + | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ .. dropdown:: h5py @@ -240,11 +240,11 @@ METplus Components Python Requirements A comprehensive library for creating static, animated, and interactive visualizations Use Case: - | `UserScript: Make OMI plot from calculated MJO indices <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_OMI.html>`_ + | `UserScript: Make OMI plot from calculated MJO indices with ERA obs only <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_OMI.html>`__ | `TCGen: Genesis Density Function and Track Density Function <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - | `UserScript: Make a Phase Diagram plot from input RMM or OMI <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ - | `UserScript: Make OMI plot from calculated MJO indices <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_OMI.html>`_ - | `UserScript: Make RMM plots from calculated MJO indices <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_RMM.html>`_ + | `UserScript: Make a Phase Diagram plot from input RMM or OMI <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ + | `UserScript: Make OMI plot from calculated MJO indices with ERA obs and GFS fcst <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ + | `UserScript: Make RMM plots from calculated MJO indices <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ | `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ .. dropdown:: metcalcpy @@ -263,8 +263,8 @@ METplus Components Python Requirements Use Case: | `UserScript: Make a Hovmoeller plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ - | `UserScript: Make a Cross Spectra plot <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - | `Grid-Stat: Verification of TC forecasts against merged TDR data <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`_ + | `UserScript: Compute Cross Spectra and Make a Plot <../generated/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.html>`__ + | `Grid-Stat: Verification of TC forecasts against merged TDR data <../generated/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.html>`_ | `UserScript: Calculate the Difficulty Index <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ | `UserScript: Make zonal and meridonial means <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_Stratosphere.html>`_ @@ -282,7 +282,7 @@ METplus Components Python Requirements Use Case: | `UserScript: Make a Hovmoeller plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ - | `UserScript: Make a Cross Spectra plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`_ + | `UserScript: Compute Cross Spectra and Make a Plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`__ | `UserScript: Calculate the Difficulty Index <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ | `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ @@ -558,13 +558,13 @@ END NEW SECTION PcpCombine, and WeatherRegime python code (eofs) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code (eofs) - <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.html>`_ + <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ * - h5py - - METplus wrappers @@ -626,9 +626,9 @@ END NEW SECTION interactive visualizations - `UserScript: Make OMI plot from - calculated MJO indices (obs only) + calculated MJO indices with ERA obs only (matplotlib) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_OMI.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_OMI.html>`__ :raw-html:`
` `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) @@ -638,17 +638,17 @@ END NEW SECTION Make a Phase Diagram plot from input RMM or OMI (matplotlib) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ :raw-html:`
` `UserScript: Make OMI plot from - calculated MJO indices + calculated MJO indices with ERA obs and GFS fcst (matplotlib) - <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_OMI.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ :raw-html:`
` `UserScript: Make RMM plots from calculated MJO indices (matplotlib) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_RMM.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ :raw-html:`
` `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities @@ -673,14 +673,14 @@ END NEW SECTION (metcalcpy) <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ :raw-html:`
` `UserScript: - Make a Cross Spectra plot + Compute Cross Spectra and Make a Plot (metcalcpy) - <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ :raw-html:`
` + <../generated/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.html>`__ :raw-html:`
` `Grid-Stat: Verification of TC forecasts against merged TDR data (metcalcpy) - <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`_ :raw-html:`
` + <../generated/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.html>`_ :raw-html:`
` `UserScript: Calculate the Difficulty Index (metcalcpy) @@ -705,9 +705,9 @@ END NEW SECTION (metplotpy) <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ :raw-html:`
` `UserScript: - Make a Cross Spectra plot + Compute Cross Spectra and Make a Plot (metplotpy) - <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`_ :raw-html:`
` + <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`__ :raw-html:`
` `UserScript: Calculate the Difficulty Index (metplotpy) @@ -849,13 +849,13 @@ END NEW SECTION RegridDataPlane, PcpCombine, and WeatherRegime python code (pylab) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code (pylab) - <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.html>`_ + <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ * - pymysql - >=1.0.2 - METcalcpy, :raw-html:`
` @@ -985,39 +985,39 @@ END NEW SECTION PcpCombine, and Blocking python code (scipy) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_Blocking.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_Blocking.html>`_ :raw-html:`
` `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code (scipy) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` `UserScript: - Make OMI plot from calculated MJO indices + Make OMI plot from calculated MJO indices with ERA obs only (obs only) (scipy) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_OMI.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_OMI.html>`__ :raw-html:`
` `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code (scipy) - <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ :raw-html:`
` `Blocking Calculation: GFS and ERA RegridDataPlane, PcpCombine, and Blocking python code (scipy) - <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_Blocking.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking.html>`_ :raw-html:`
` `UserScript: Make a Phase Diagram plot from input RMM or OMI (scipy) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`__ :raw-html:`
` `UserScript: - Make OMI plot from calculated MJO indices + Make OMI plot from calculated MJO indices with ERA obs and GFS fcst (scipy) - <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_OMI.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ :raw-html:`
` `UserScript: Make RMM plots from calculated MJO indices (scipy) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_RMM.html>`_ + <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ * - sklearn - - METplus wrappers @@ -1028,11 +1028,11 @@ END NEW SECTION - `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code (sklearn) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_WeatherRegime.html>`_ :raw-html:`
` + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code (sklearn) - <../generated/model_applications/s2s/UserScript_fcstGFS_obsERA_WeatherRegime.html>`_ + <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ * - xarray - >=2023.1.0 - METplus wrappers, :raw-html:`
` From 514be9ec317b464061fa6ec14f06c4d498ddfe76 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Thu, 18 Jan 2024 12:34:59 -0700 Subject: [PATCH 23/47] Fixing spelling and capitalization --- .../s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py b/docs/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py index 8733d24c41..855321191d 100644 --- a/docs/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py +++ b/docs/use_cases/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.py @@ -1,5 +1,5 @@ """ -UserScript: Compue Cross Spectra and make a plot +UserScript: Compute Cross Spectra and Make a Plot ======================================================================== model_applications/ From 9a78b0920b3222c77e35364628bdaf1069b8ad8d Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Thu, 18 Jan 2024 12:49:19 -0700 Subject: [PATCH 24/47] Removing the dash in front of 1.4 for nc-time-axis --- docs/Users_Guide/overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index cb7763c6c9..4d873f7c8a 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -301,7 +301,7 @@ METplus Components Python Requirements Use Case: `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ -.. dropdown:: nc-time-axis -1.4 +.. dropdown:: nc-time-axis 1.4 METplus Component: | METplotpy From e550ccaffed98d43069c0133d7ddd3d067b144bf Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Thu, 18 Jan 2024 12:50:17 -0700 Subject: [PATCH 25/47] Modifying formatting --- docs/Users_Guide/overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 4d873f7c8a..a955f2e684 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -311,7 +311,7 @@ METplus Components Python Requirements | https://github.com/SciTools/nc-time-axis Description: - Extension to cftime \**REQUIRES Python 3.7 + Extension to cftime - **REQUIRES Python 3.7** NEW SECTION From bf9019181850aac7765b2c2f400f09d949c6aaa9 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 18 Jan 2024 14:40:11 -0700 Subject: [PATCH 26/47] adding dropdowns thru pylab --- docs/Users_Guide/overview.rst | 114 ++++++++++++++++++++++++++++++++++ 1 file changed, 114 insertions(+) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index a955f2e684..86e94ed176 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -315,6 +315,120 @@ METplus Components Python Requirements NEW SECTION +.. dropdown:: netCDF4 >=1.6.2 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://unidata.github.io/netcdf4-python/ + + Description: + + A Python interface to the netCDF C library + + Use Case: + For using MET Python embedding functionality in use cases + +.. dropdown:: numpy >=1.24.2 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://numpy.org/ + + Description: + NumPy offers comprehensive mathematical functions, random number generators, + linear algebra routines, Fourier transforms, and more. + + Use Case: + For using MET Python embedding functionality in use cases + +.. dropdown:: pandas >=1.5.2 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://pypi.org/project/pandas + + Description: + A fast, powerful, flexible and easy to use open source data analysis + and manipulation tool, built on top of the Python programming language + + Use Case: + For using MET Python embedding functionality in use cases + +.. dropdown:: pint >=0.20.1 + + METplus Component: + METcalcpy + + Source: + https://github.com/hgrecco/pint + + Description: + Python package to define, operate and manipulate physical quantities + +.. dropdown:: plotly >=5.13.0 + + METplus Component: + | METcalcpy, + |METplotpy + + Source: + https://github.com/plotly/plotly.py + + Description: + Makes interactive, publication-quality graphs + +.. dropdown:: pygrib + + METplus Component: + METplus wrappers + + Source: + https://github.com/jswhit/pygrib + + Description: + For reading/writing GRIB files + + Use Case: + | `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ + | `GridStat: Cloud Fractions Using GFS and ERA5 Data <../generated/model_applications/clouds/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.html>`_ + | `GridStat: Cloud Height with Neighborhood and Probabilities <../generated/model_applications/clouds/GridStat_fcstMPAS_obsERA5_cloudBaseHgt.html>`_ + | `GridStat: Cloud Pressure and Temperature Heights <../generated/model_applications/clouds/GridStat_fcstGFS_obsSATCORPS_cloudTopPressAndTemp.html>`_ + | `GridStat: Cloud Fractions Using GFS and MERRA2 Data <../generated/model_applications/clouds/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.html>`_ + | `GridStat: Cloud Fractions Using MPAS and SatCORPS Data <../generated/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac.html>`_ + | `GridStat: Cloud Fractions Using MPAS and MERRA2 Data <../generated/model_applications/clouds/GridStat_fcstMPAS_obsMERRA2_lowAndTotalCloudFrac.html>`_ + + +.. dropdown:: pylab + + METplus Component: + METplus wrappers + + Source: + https://pypi.org/project/matplotlib/ + + Description: + A convenience module that bulk imports matplotlib.pyplot (for plotting) and NumPy (for +Mathematics and working with arrays) in a single name space + + Use Case: + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ + | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ + + .. dropdown:: METplus Component: From a92919c26cd189626e5a77c2e7ef262659cf3156 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 18 Jan 2024 14:45:44 -0700 Subject: [PATCH 27/47] fixing problems --- docs/Users_Guide/overview.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 86e94ed176..355e032aaa 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -383,7 +383,7 @@ NEW SECTION METplus Component: | METcalcpy, - |METplotpy + | METplotpy Source: https://github.com/plotly/plotly.py @@ -422,7 +422,7 @@ NEW SECTION Description: A convenience module that bulk imports matplotlib.pyplot (for plotting) and NumPy (for -Mathematics and working with arrays) in a single name space + Mathematics and working with arrays) in a single name space Use Case: | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ From 8f7f87f6fc1d7d5cdd6f333af40c8bb82590df80 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 18 Jan 2024 15:11:04 -0700 Subject: [PATCH 28/47] dropdowns thru scikit-learn --- docs/Users_Guide/overview.rst | 116 +++++++++++++++++++++++++++++++++- 1 file changed, 114 insertions(+), 2 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 355e032aaa..7d9e2f66e8 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -313,8 +313,6 @@ METplus Components Python Requirements Description: Extension to cftime - **REQUIRES Python 3.7** -NEW SECTION - .. dropdown:: netCDF4 >=1.6.2 METplus Component: @@ -428,6 +426,120 @@ NEW SECTION | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ +NEW SECTION + +.. dropdown:: pymysql >=1.0.2 + + METplus Component: + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://pypi.org/project/psutil/ + + Description: + A pure-Python MySQL client library, based on PEP 249 + +.. dropdown:: pyproj >=2.3.1 + + METplus Component: + METplus wrappers + + Source: + https://github.com/pyproj4/pyproj/archive/v2.3.1rel.tar.gz + + Description: + Python interface to PROJ (cartographic projections and coordinate transformations library) + + Use Case: + | `GridStat: Python Embedding to read and process ice cover <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ + +.. dropdown:: pyresample + + METplus Component: + METplus wrappers + + METplus Component: + https://github.com/pytroll/pyresample + + Description: + For resampling geospatial image data + + Use Case: + | `GridStat: Python Embedding to read and process SST <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ + | `GridStat: Python Embedding to read and process ice cover <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ + | `GridStat: Python Embedding for sea surface salinity using level 3, 1 day composite obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ + | `GridStat: Python Embedding for sea surface salinity using level 3, 8 day mean obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ + +.. dropdown:: pytest >=7.2.1 + + METplus Component: + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://github.com/pytest-dev/pytest/archive/5.2.1.tar.gz + + Description: + A mature full-featured Python testing tool that helps to write better programs + +.. dropdown:: python-kaleido >=0.2.1 + + METplus Component: + | METcalcpy, + | METplotpy + + Source: + https://pypi.org/project/kaleido/ + + Description: + Provides a low-level Python API that is designed to be used by high-level plotting libraries like Plotly + +.. dropdown:: pyyaml >=6.0 + + METplus Component: + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://github.com/yaml/pyyaml + + Description: + A full-featured YAML framework for the Python programming language + +.. dropdown:: scikit-image >=0.19.3 + + METplus Component: + | METcalcpy, + | METplotpy + + Source: + https://scikit-image.org + + Description: + A collection of algorithms for image processing + +.. dropdown:: scikit-learn >=1.2.2 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://github.com/scikit-learn/scikit-learn/releases + + Description: + Open Source library for Machine Learning in Python + + Use Case: + | `GridStat: Python Embedding to read and process SST <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ + | `GridStat: Python Embedding to read and process ice cover <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ + | `GridStat: Python Embedding for sea surface salinity using level 3, 1 day composite obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ + | `GridStat: Python Embedding for sea surface salinity using level 3, 8 day mean obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ .. dropdown:: From 2486dfeef65e7d0607033488c2250a7bdc0e58c7 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 18 Jan 2024 15:17:09 -0700 Subject: [PATCH 29/47] fixing spacing --- docs/Users_Guide/overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 7d9e2f66e8..f16f1b2cf6 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -501,7 +501,7 @@ NEW SECTION METplus Component: | METcalcpy, - | METplotpy, + | METplotpy, | METdataio Source: From f1ea651263ebc2cfe17b20a06099e6e2de5d235a Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 18 Jan 2024 15:57:35 -0700 Subject: [PATCH 30/47] final dropdowns thru yaml --- docs/Users_Guide/overview.rst | 148 +++++++++++----------------------- 1 file changed, 45 insertions(+), 103 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index f16f1b2cf6..a3de957410 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -426,8 +426,6 @@ METplus Components Python Requirements | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ -NEW SECTION - .. dropdown:: pymysql >=1.0.2 METplus Component: @@ -541,147 +539,91 @@ NEW SECTION | `GridStat: Python Embedding for sea surface salinity using level 3, 1 day composite obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ | `GridStat: Python Embedding for sea surface salinity using level 3, 8 day mean obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ -.. dropdown:: - - METplus Component: - - Source: - - Description: - - Use Case: - -.. dropdown:: - - METplus Component: - - Source: - - Description: - - Use Case: - -.. dropdown:: - - METplus Component: - - Source: - - Description: - - Use Case: - -.. dropdown:: - - METplus Component: - - Source: - - Description: - - Use Case: - -.. dropdown:: - - METplus Component: - - Source: - - Description: - - Use Case: - -.. dropdown:: - - METplus Component: - - Source: - - Description: - - Use Case: - -.. dropdown:: - - METplus Component: - - Source: - - Description: - - Use Case: +NEW SECTION -.. dropdown:: +.. dropdown:: scipy >=1.9.3 - METplus Component: + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy Source: + https://www.scipy.org/ Description: + Wraps highly-optimized implementations written in low-level languages like Fortran, C, and C++ Use Case: + | `Blocking Calculation: ERA RegridDataPlane, PcpCombine, and Blocking python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_Blocking.html>`_ + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ + | `UserScript: Make OMI plot from calculated MJO indices with ERA obs only <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_OMI.html>`__ + | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ + | `Blocking Calculation: GFS and ERA RegridDataPlane, PcpCombine, and Blocking python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking.html>`_ + | `UserScript: Make a Phase Diagram plot from input RMM or OMI <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`__ + | `UserScript: Make OMI plot from calculated MJO indices with ERA obs and GFS fcst <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ + | `UserScript: Make RMM plots from calculated MJO indices <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ -.. dropdown:: +.. dropdown:: sklearn - METplus Component: + METplus Component: + METplus wrappers Source: + https://www.kite.com/python/docs/sklearn Description: - - Use Case: - -.. dropdown:: - - METplus Component: - - Source: + Simple and efficient tools for predictive data analysis Description: + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ + | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - Use Case: -.. dropdown:: +.. dropdown:: xarray >=2023.1.0 - METplus Component: + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy Source: + https://xarray.pydata.org/en/v0.17.0/ Description: + Makes working with labelled multi-dimensional arrays simple, efficient, and fun Use Case: + For using MET Python embedding functionality in use cases -.. dropdown:: +.. dropdown:: xesmf - METplus Component: + METplus Component: + METplus wrappers Source: + NOTE: The xesmf package will not be installed on WCOSS2 and there is an open GitHub issue to + replace the package in the use case that uses it: + https://github.com/dtcenter/METplus/issues/1314 Description: + |For regridding Use Case: + `PlotDataPlane: Python Embedding of tripolar coordinate file <../generated/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.html>`_ -.. dropdown:: - METplus Component: - - Source: +.. dropdown:: yaml - Description: - - Use Case: - -.. dropdown:: - - METplus Component: + METplus Component: + | METcalcpy, + | METplotpy Source: + https://pypi.org/project/PyYAML/ Description: - - Use Case: - - + To load, read, and write YAML files with PyYAML END NEW SECTION From 4ea01999efecfd5dbc669dd8204f9fa8a48d5739 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 18 Jan 2024 16:04:46 -0700 Subject: [PATCH 31/47] fixing spacing --- docs/Users_Guide/overview.rst | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index a3de957410..88eca5bbca 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -539,8 +539,6 @@ METplus Components Python Requirements | `GridStat: Python Embedding for sea surface salinity using level 3, 1 day composite obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ | `GridStat: Python Embedding for sea surface salinity using level 3, 8 day mean obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ -NEW SECTION - .. dropdown:: scipy >=1.9.3 METplus Component: @@ -607,7 +605,7 @@ NEW SECTION https://github.com/dtcenter/METplus/issues/1314 Description: - |For regridding + For regridding Use Case: `PlotDataPlane: Python Embedding of tripolar coordinate file <../generated/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.html>`_ @@ -625,8 +623,6 @@ NEW SECTION Description: To load, read, and write YAML files with PyYAML -END NEW SECTION - .. Number of characters per line: Name - no more that 13 characters Version - no more than 6 characters From d8cd40d248d9cb537c357297891675bf38f07746 Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Thu, 18 Jan 2024 16:35:17 -0700 Subject: [PATCH 32/47] fixing loose ends --- docs/Users_Guide/overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 88eca5bbca..871745f448 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -311,7 +311,7 @@ METplus Components Python Requirements | https://github.com/SciTools/nc-time-axis Description: - Extension to cftime - **REQUIRES Python 3.7** + Extension to cftime - \**REQUIRES Python 3.7** .. dropdown:: netCDF4 >=1.6.2 From d3e3e0ee381ef8c016490fff7ff3a11f21393cc8 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 22 Jan 2024 12:58:32 -0700 Subject: [PATCH 33/47] Per #2463, moving information to an Appendix and adding text and links in an overview --- docs/Users_Guide/appendixA.rst | 1177 +++++++++++++++++++++++++++++ docs/Users_Guide/installation.rst | 2 + 2 files changed, 1179 insertions(+) create mode 100644 docs/Users_Guide/appendixA.rst diff --git a/docs/Users_Guide/appendixA.rst b/docs/Users_Guide/appendixA.rst new file mode 100644 index 0000000000..7dd6ac5733 --- /dev/null +++ b/docs/Users_Guide/appendixA.rst @@ -0,0 +1,1177 @@ +.. _components_python_packages: + +#.. _python_requirements_table: + +********************************************* +Appendix A METplus Components Python Packages +********************************************* + +Overview +======== + +The information below is intended to be an overview of the Python package +requirements for METplus (including use cases), MET Python Embedding, +METcalcpy, METplotpy, and METdataio. + +.. note:: Many of the Python packages listed below are OPTIONAL and not required. + +For information regarding the Python package requirements for each of the +METplus components, please see the documentation for the desired METplus +component listed below. Please note that the documentation for the METplus +Use Cases lists the required Python packages in the individual Use Cases +documentation. + + * :ref:`METplus Python Package Requirements ` + * `MET Python Embedding Requirements `_ + * `METcalcpy Python Package Requirements `_ + * `METdataio Python Package Requirements `_ + * `METplotpy Python Package Requirements `_ + * `METviewer Python Package Requirements `_ + * `METexpress Python Package Requirements `_ + + +METplus Components Python Packages +================================== + +.. dropdown:: Python 3.10.4+ + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy, + | METdataio + +.. dropdown:: cartopy >=0.21.1 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://scitools.org.uk/cartopy/docs/latest/ + + Description: + Designed for geospatial data processing in order to produce maps and other geospatial data analyses + + Use Cases: + | `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + | `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ + +.. dropdown:: cfgrib + + METplus Component: + METplus wrappers + + Source: + https://pypi.org/project/cfgrib/ + + Description: + Map GRIB files to the NetCDF Common Data Model following the CF Convention using ecCodes + + Use Cases: + `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields + <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ + +.. dropdown:: cmocean + + METplus Component: + | METcalcpy, + | METplotpy + + Source: + https://pypi.org/project/cmocean/ + + Description: + Contains colormaps for commonly-used oceanographic variables + +.. dropdown:: dateutil >=2.8.2 + + METplus Component: + METplus wrappers + + Source: + https://github.com/dateutil/dateutil/releases + + Description: + Provides powerful extensions to the standard datetime module + + Use Cases: + Most + +.. dropdown:: eofs + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://pypi.org/project/eofs/ + + Description: + Empirical orthogonal functions analysis of spatial-temporal data + + Use Cases: + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` + | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ + +.. dropdown:: h5py + + METplus Component: + METplus wrappers + + Source: + https://github.com/h5py/h5py + + Description: + Pythonic interface to the HDF5 binary data format + + Use Case: + `PCPCombine: Python Embedding Use Case <../generated/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.html>`_ + +.. dropdown:: imutils >=0.5.4 + + METplus Component: + METplotpy + + Source: + https://pypi.org/project/imutils/ + + Description: + A series of convenience functions to make basic image processing functions such as translation, rotation, resizing, skeletonization, displaying Matplotlib images, sorting contours, detecting edges, and much more easier + +.. dropdown:: imageio + + METplus Component: + | METcalcpy, + | METplotpy + + Source: + https://pypi.org/project/imageio/ + + Description: + Provides an easy interface to read and write a wide range of image data, including animated + images, volumetric data, and scientific formats + +.. dropdown:: lxml >=4.9.1 + + METplus Component: + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://pypi.org/project/lxml/ + + Description: + A Pythonic binding for the C libraries libxml2 and libxslt + +.. dropdown:: matplotlib >=3.6.3 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://matplotlib.org/stable/users/installing/index.html + + Description: + A comprehensive library for creating static, animated, and interactive visualizations + + Use Case: + | `UserScript: Make OMI plot from calculated MJO indices with ERA obs only <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_OMI.html>`__ + | `TCGen: Genesis Density Function and Track Density Function <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + | `UserScript: Make a Phase Diagram plot from input RMM or OMI <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ + | `UserScript: Make OMI plot from calculated MJO indices with ERA obs and GFS fcst <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ + | `UserScript: Make RMM plots from calculated MJO indices <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ + | `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ + +.. dropdown:: metcalcpy + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://github.com/dtcenter/METcalcpy/releases + + Description: + A Python version of the statistics calculation functionality of METviewer, METexpress, + plotting packages in METplotpy and is a stand-alone package for any other application + + Use Case: + | `UserScript: Make a Hovmoeller plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ + | `UserScript: Compute Cross Spectra and Make a Plot <../generated/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.html>`__ + | `Grid-Stat: Verification of TC forecasts against merged TDR data <../generated/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.html>`_ + | `UserScript: Calculate the Difficulty Index <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ + | `UserScript: Make zonal and meridonial means <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_Stratosphere.html>`_ + +.. dropdown:: metplotpy + + METplus Component: + METplus wrappers + + Source: + https://github.com/dtcenter/METplotpy/releases + + Description: + Contains packages for plotting in METplus as stand-alone, or part of METplus use case, + METplus wrappers, METexpress, or METviewer + + Use Case: + | `UserScript: Make a Hovmoeller plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ + | `UserScript: Compute Cross Spectra and Make a Plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`__ + | `UserScript: Calculate the Difficulty Index <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ + | `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + +.. dropdown:: metpy >=1.4.0 + + METplus Component: + METplus wrappers + + Source: + https://www.unidata.ucar.edu/software/metpy/ + + Description: + A collection of tools in Python for reading, visualizing, and performing calculations + with weather data + + Use Case: + `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ + +.. dropdown:: nc-time-axis 1.4 + + METplus Component: + | METplotpy + | stratosphere_diagnostics + + Source: + | https://github.com/SciTools/nc-time-axis + + Description: + Extension to cftime - \**REQUIRES Python 3.7** + +.. dropdown:: netCDF4 >=1.6.2 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://unidata.github.io/netcdf4-python/ + + Description: + + A Python interface to the netCDF C library + + Use Case: + For using MET Python embedding functionality in use cases + +.. dropdown:: numpy >=1.24.2 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://numpy.org/ + + Description: + NumPy offers comprehensive mathematical functions, random number generators, + linear algebra routines, Fourier transforms, and more. + + Use Case: + For using MET Python embedding functionality in use cases + +.. dropdown:: pandas >=1.5.2 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://pypi.org/project/pandas + + Description: + A fast, powerful, flexible and easy to use open source data analysis + and manipulation tool, built on top of the Python programming language + + Use Case: + For using MET Python embedding functionality in use cases + +.. dropdown:: pint >=0.20.1 + + METplus Component: + METcalcpy + + Source: + https://github.com/hgrecco/pint + + Description: + Python package to define, operate and manipulate physical quantities + +.. dropdown:: plotly >=5.13.0 + + METplus Component: + | METcalcpy, + | METplotpy + + Source: + https://github.com/plotly/plotly.py + + Description: + Makes interactive, publication-quality graphs + +.. dropdown:: pygrib + + METplus Component: + METplus wrappers + + Source: + https://github.com/jswhit/pygrib + + Description: + For reading/writing GRIB files + + Use Case: + | `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ + | `GridStat: Cloud Fractions Using GFS and ERA5 Data <../generated/model_applications/clouds/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.html>`_ + | `GridStat: Cloud Height with Neighborhood and Probabilities <../generated/model_applications/clouds/GridStat_fcstMPAS_obsERA5_cloudBaseHgt.html>`_ + | `GridStat: Cloud Pressure and Temperature Heights <../generated/model_applications/clouds/GridStat_fcstGFS_obsSATCORPS_cloudTopPressAndTemp.html>`_ + | `GridStat: Cloud Fractions Using GFS and MERRA2 Data <../generated/model_applications/clouds/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.html>`_ + | `GridStat: Cloud Fractions Using MPAS and SatCORPS Data <../generated/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac.html>`_ + | `GridStat: Cloud Fractions Using MPAS and MERRA2 Data <../generated/model_applications/clouds/GridStat_fcstMPAS_obsMERRA2_lowAndTotalCloudFrac.html>`_ + + +.. dropdown:: pylab + + METplus Component: + METplus wrappers + + Source: + https://pypi.org/project/matplotlib/ + + Description: + A convenience module that bulk imports matplotlib.pyplot (for plotting) and NumPy (for + Mathematics and working with arrays) in a single name space + + Use Case: + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ + | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ + +.. dropdown:: pymysql >=1.0.2 + + METplus Component: + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://pypi.org/project/psutil/ + + Description: + A pure-Python MySQL client library, based on PEP 249 + +.. dropdown:: pyproj >=2.3.1 + + METplus Component: + METplus wrappers + + Source: + https://github.com/pyproj4/pyproj/archive/v2.3.1rel.tar.gz + + Description: + Python interface to PROJ (cartographic projections and coordinate transformations library) + + Use Case: + | `GridStat: Python Embedding to read and process ice cover <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ + +.. dropdown:: pyresample + + METplus Component: + METplus wrappers + + METplus Component: + https://github.com/pytroll/pyresample + + Description: + For resampling geospatial image data + + Use Case: + | `GridStat: Python Embedding to read and process SST <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ + | `GridStat: Python Embedding to read and process ice cover <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ + | `GridStat: Python Embedding for sea surface salinity using level 3, 1 day composite obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ + | `GridStat: Python Embedding for sea surface salinity using level 3, 8 day mean obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ + +.. dropdown:: pytest >=7.2.1 + + METplus Component: + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://github.com/pytest-dev/pytest/archive/5.2.1.tar.gz + + Description: + A mature full-featured Python testing tool that helps to write better programs + +.. dropdown:: python-kaleido >=0.2.1 + + METplus Component: + | METcalcpy, + | METplotpy + + Source: + https://pypi.org/project/kaleido/ + + Description: + Provides a low-level Python API that is designed to be used by high-level plotting libraries like Plotly + +.. dropdown:: pyyaml >=6.0 + + METplus Component: + | METcalcpy, + | METplotpy, + | METdataio + + Source: + https://github.com/yaml/pyyaml + + Description: + A full-featured YAML framework for the Python programming language + +.. dropdown:: scikit-image >=0.19.3 + + METplus Component: + | METcalcpy, + | METplotpy + + Source: + https://scikit-image.org + + Description: + A collection of algorithms for image processing + +.. dropdown:: scikit-learn >=1.2.2 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://github.com/scikit-learn/scikit-learn/releases + + Description: + Open Source library for Machine Learning in Python + + Use Case: + | `GridStat: Python Embedding to read and process SST <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ + | `GridStat: Python Embedding to read and process ice cover <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ + | `GridStat: Python Embedding for sea surface salinity using level 3, 1 day composite obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ + | `GridStat: Python Embedding for sea surface salinity using level 3, 8 day mean obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ + +.. dropdown:: scipy >=1.9.3 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://www.scipy.org/ + + Description: + Wraps highly-optimized implementations written in low-level languages like Fortran, C, and C++ + + Use Case: + | `Blocking Calculation: ERA RegridDataPlane, PcpCombine, and Blocking python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_Blocking.html>`_ + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ + | `UserScript: Make OMI plot from calculated MJO indices with ERA obs only <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_OMI.html>`__ + | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ + | `Blocking Calculation: GFS and ERA RegridDataPlane, PcpCombine, and Blocking python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking.html>`_ + | `UserScript: Make a Phase Diagram plot from input RMM or OMI <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`__ + | `UserScript: Make OMI plot from calculated MJO indices with ERA obs and GFS fcst <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ + | `UserScript: Make RMM plots from calculated MJO indices <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ + +.. dropdown:: sklearn + + METplus Component: + METplus wrappers + + Source: + https://www.kite.com/python/docs/sklearn + + Description: + Simple and efficient tools for predictive data analysis + + Description: + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ + | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ + + +.. dropdown:: xarray >=2023.1.0 + + METplus Component: + | METplus wrappers, + | METcalcpy, + | METplotpy + + Source: + https://xarray.pydata.org/en/v0.17.0/ + + Description: + Makes working with labelled multi-dimensional arrays simple, efficient, and fun + + Use Case: + For using MET Python embedding functionality in use cases + +.. dropdown:: xesmf + + METplus Component: + METplus wrappers + + Source: + NOTE: The xesmf package will not be installed on WCOSS2 and there is an open GitHub issue to + replace the package in the use case that uses it: + https://github.com/dtcenter/METplus/issues/1314 + + Description: + For regridding + + Use Case: + `PlotDataPlane: Python Embedding of tripolar coordinate file <../generated/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.html>`_ + + +.. dropdown:: yaml + + METplus Component: + | METcalcpy, + | METplotpy + + Source: + https://pypi.org/project/PyYAML/ + + Description: + To load, read, and write YAML files with PyYAML + +.. Number of characters per line: + Name - no more that 13 characters + Version - no more than 6 characters + METplus component - no more than 17 characters + Source - no more than 8 characters + Description - no more than 22 (was 20) characters + Use Cases - no more than 17 (was 10) characters + +.. role:: raw-html(raw) + :format: html + +.. list-table:: METplus Components Python Requirements + :widths: auto + :header-rows: 1 + + * - Name + - Version + - METplus Component + - Source + - Description + - Use Cases (only applicable for METplus wrappers component)(followed by + python package name) + * - Python 3.10.4+ + - + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy, :raw-html:`
` + METdataio + - + - + - + * - cartopy + - >=0.21.1 + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy + - https://scitools.org.uk/cartopy/docs/latest/ + - Designed for :raw-html:`
` + geospatial data :raw-html:`
` + processing in :raw-html:`
` + order to produce :raw-html:`
` + maps and other :raw-html:`
` + geospatial data :raw-html:`
` + analyses + - `TCGen: Genesis Density Function (GDF) + and Track Density Function (TDF) + (cartopy) + <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ :raw-html:`
` + `CyclonePlotter: Extra-TC Tracker + and Plotting Capabilities + (cartopy) + <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ + * - cfgrib + - + - METplus wrappers + - https://pypi.org/project/cfgrib/ + - map GRIB files :raw-html:`
` + to the NetCDF :raw-html:`
` + Common Data Model :raw-html:`
` + following the :raw-html:`
` + CF Convention :raw-html:`
` + using ecCodes + - `Multi_Tool: + Feature Relative by Lead using + Multiple User-Defined Fields + (cfgrib) + <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ + * - cmocean + - + - METcalcpy, :raw-html:`
` + METplotpy + - https://pypi.org/project/cmocean/ + - contains colormaps :raw-html:`
` + for commonly-used :raw-html:`
` + oceanographic variables + - + * - dateutil + - >=2.8.2 + - METplus wrappers + - https://github.com/dateutil/dateutil/releases + - provides powerful :raw-html:`
` + extensions to the :raw-html:`
` + standard datetime :raw-html:`
` + module + - Most + * - eofs + - + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy + - https://pypi.org/project/eofs/ + - empirical orthogonal :raw-html:`
` + functions analysis of :raw-html:`
` + spatial-temporal data + - `WeatherRegime Calculation: + RegridDataPlane, + PcpCombine, + and WeatherRegime python code + (eofs) + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` + `WeatherRegime Calculation: + GFS and ERA RegridDataPlane, + PcpCombine, and + WeatherRegime python code + (eofs) + <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ + * - h5py + - + - METplus wrappers + - https://github.com/h5py/h5py + - Pythonic interface :raw-html:`
` + to the HDF5 :raw-html:`
` + binary data format + - `PCPCombine: + Python Embedding Use Case + (h5py) + <../generated/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.html>`_ + * - imutils + - >=0.5.4 + - METplotpy :raw-html:`
` + - https://pypi.org/project/imutils/ + - A series of convenience :raw-html:`
` + functions to make basic :raw-html:`
` + image processing :raw-html:`
` + functions such as :raw-html:`
` + translation, rotation, :raw-html:`
` + resizing, skeletonization, :raw-html:`
` + displaying Matplotlib :raw-html:`
` + images, sorting contours, :raw-html:`
` + detecting edges, :raw-html:`
` + and much more easier + - + * - imageio + - + - METcalcpy, :raw-html:`
` + METplotpy + - https://pypi.org/project/imageio/ + - provides an easy :raw-html:`
` + interface to read :raw-html:`
` + and write a wide :raw-html:`
` + range of image data, :raw-html:`
` + including animated :raw-html:`
` + images, volumetric data, :raw-html:`
` + and scientific formats + - + * - lxml + - >=4.9.1 + - METcalcpy, :raw-html:`
` + METplotpy, :raw-html:`
` + METdataio + - https://pypi.org/project/lxml/ + - a Pythonic binding for :raw-html:`
` + the C libraries :raw-html:`
` + libxml2 and libxslt + - + * - matplotlib + - >=3.6.3 + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy + - https://matplotlib.org/stable/users/installing/index.html + - a comprehensive library :raw-html:`
` + for creating static, :raw-html:`
` + animated, and :raw-html:`
` + interactive visualizations + - `UserScript: + Make OMI plot from + calculated MJO indices with ERA obs only + (matplotlib) + <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_OMI.html>`__ :raw-html:`
` + `TCGen: + Genesis Density Function (GDF) + and Track Density Function (TDF) + (matplotlib) + <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ :raw-html:`
` + `UserScript: + Make a Phase Diagram plot + from input RMM or OMI + (matplotlib) + <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ :raw-html:`
` + `UserScript: + Make OMI plot from + calculated MJO indices with ERA obs and GFS fcst + (matplotlib) + <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ :raw-html:`
` + `UserScript: + Make RMM plots from + calculated MJO indices + (matplotlib) + <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ :raw-html:`
` + `CyclonePlotter: + Extra-TC Tracker and + Plotting Capabilities + (matplotlib) + <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ :raw-html:`
` + * - metcalcpy + - + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy + - https://github.com/dtcenter/METcalcpy/releases + - a Python version of the :raw-html:`
` + statistics calculation :raw-html:`
` + functionality of :raw-html:`
` + METviewer, METexpress, :raw-html:`
` + plotting packages in :raw-html:`
` + METplotpy and is a :raw-html:`
` + stand-alone package for :raw-html:`
` + any other application + - `UserScript: + Make a Hovmoeller plot + (metcalcpy) + <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ :raw-html:`
` + `UserScript: + Compute Cross Spectra and Make a Plot + (metcalcpy) + <../generated/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.html>`__ :raw-html:`
` + `Grid-Stat: + Verification of TC forecasts + against merged TDR data + (metcalcpy) + <../generated/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.html>`_ :raw-html:`
` + `UserScript: + Calculate the Difficulty Index + (metcalcpy) + <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ :raw-html:`
` + `UserScript: + Make zonal and meridonial means + (metcalcpy) + <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_Stratosphere.html>`_ :raw-html:`
` + * - metplotpy + - + - METplus wrappers + - https://github.com/dtcenter/METplotpy/releases + - contains packages for :raw-html:`
` + plotting in METplus as :raw-html:`
` + stand-alone, or part of :raw-html:`
` + METplus use case, :raw-html:`
` + METplus wrappers, :raw-html:`
` + METexpress, :raw-html:`
` + or METviewer + - `UserScript: + Make a Hovmoeller plot + (metplotpy) + <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ :raw-html:`
` + `UserScript: + Compute Cross Spectra and Make a Plot + (metplotpy) + <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`__ :raw-html:`
` + `UserScript: + Calculate the Difficulty Index + (metplotpy) + <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ :raw-html:`
` + `TCGen: + Genesis Density Function (GDF) + and Track Density Function (TDF) + (metplotpy) + <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ + * - metpy + - >=1.4.0 + - METplus wrappers + - https://www.unidata.ucar.edu/software/metpy/ + - a collection of tools :raw-html:`
` + in Python for reading, :raw-html:`
` + visualizing, and :raw-html:`
` + performing calculations :raw-html:`
` + with weather data + - `Multi_Tool: + Feature Relative by Lead using + Multiple User-Defined Fields + (metpy) + <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ + * - nc-time-axis + - 1.4 + - METplotpy :raw-html:`
` + stratosphere_diagnostics + - https://github.com/SciTools/nc-time-axis + - extension to cftime :raw-html:`
` + \**REQUIRES Python 3.7 + - + * - netCDF4 + - >=1.6.2 + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy + - https://unidata.github.io/netcdf4-python/ + - a Python interface to :raw-html:`
` + the netCDF C library + - For using MET Python embedding functionality in use cases + * - numpy + - >=1.24.2 + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy, :raw-html:`
` + METdataio + - https://numpy.org/ + - NumPy offers :raw-html:`
` + comprehensive :raw-html:`
` + mathematical functions, :raw-html:`
` + random number generators, :raw-html:`
` + linear algebra routines, :raw-html:`
` + Fourier transforms, and more. + - For using MET Python embedding functionality in use cases + * - pandas + - >=1.5.2 + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy, :raw-html:`
` + METdataio + - https://pypi.org/project/pandas + - a fast, powerful, :raw-html:`
` + flexible and easy to use :raw-html:`
` + open source data analysis :raw-html:`
` + and manipulation tool, :raw-html:`
` + built on top of the :raw-html:`
` + Python programming :raw-html:`
` + language + - For using MET Python embedding functionality in use cases + * - pint + - >=0.20.1 + - METcalcpy + - https://github.com/hgrecco/pint + - Python package to define, :raw-html:`
` + operate and manipulate :raw-html:`
` + physical quantities + - + * - plotly + - >=5.13.0 + - METcalcpy, :raw-html:`
` + METplotpy + - https://github.com/plotly/plotly.py + - makes interactive, :raw-html:`
` + publication-quality graphs + - + * - pygrib + - + - METplus wrappers + - https://github.com/jswhit/pygrib + - for reading/writing :raw-html:`
` + GRIB files + - `Multi_Tool: + Feature Relative by Lead + using Multiple User-Defined Fields + (pygrib) + <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ :raw-html:`
` + `GridStat: + Cloud Fractions Using GFS + and ERA5 Data + (pygrib) + <../generated/model_applications/clouds/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.html>`_ :raw-html:`
` + `GridStat: + Cloud Height with Neighborhood + and Probabilities + (pygrib) + <../generated/model_applications/clouds/GridStat_fcstMPAS_obsERA5_cloudBaseHgt.html>`_ :raw-html:`
` + `GridStat: + Cloud Pressure and + Temperature Heights + (pygrib) + <../generated/model_applications/clouds/GridStat_fcstGFS_obsSATCORPS_cloudTopPressAndTemp.html>`_ :raw-html:`
` + `GridStat: + Cloud Fractions Using GFS + and MERRA2 Data + (pygrib) + <../generated/model_applications/clouds/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.html>`_ :raw-html:`
` + `GridStat: + Cloud Fractions Using MPAS + and SatCORPS Data + (pygrib) + <../generated/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac.html>`_ :raw-html:`
` + `GridStat: + Cloud Fractions Using MPAS + and MERRA2 Data + (pygrib) + <../generated/model_applications/clouds/GridStat_fcstMPAS_obsMERRA2_lowAndTotalCloudFrac.html>`_ + * - pylab + - + - METplus wrappers + - https://pypi.org/project/matplotlib/ + - a convenience module :raw-html:`
` + that bulk imports :raw-html:`
` + matplotlib.pyplot (for :raw-html:`
` + plotting) and NumPy (for :raw-html:`
` + Mathematics and working :raw-html:`
` + with arrays) in a :raw-html:`
` + single name space + - `WeatherRegime Calculation: + RegridDataPlane, PcpCombine, + and WeatherRegime python code + (pylab) + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` + `WeatherRegime Calculation: + GFS and ERA RegridDataPlane, + PcpCombine, and WeatherRegime + python code + (pylab) + <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ + * - pymysql + - >=1.0.2 + - METcalcpy, :raw-html:`
` + METplotpy, :raw-html:`
` + METdataio + - https://pypi.org/project/psutil/ + - a pure-Python MySQL :raw-html:`
` + client library, :raw-html:`
` + based on PEP 249 + - + * - pyproj + - >=2.3.1 + - METplus wrappers + - https://github.com/pyproj4/pyproj/archive/v2.3.1rel.tar.gz + - Python interface to PROJ :raw-html:`
` + (cartographic projections and :raw-html:`
` + coordinate transformations library) + - `GridStat: + Python Embedding to read + and process ice cover + (pyproj) + <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ + * - pyresample + - + - METplus wrappers + - https://github.com/pytroll/pyresample + - for resampling geospatial :raw-html:`
` + image data + - `GridStat: + Python Embedding to read and + process SST + (pyresample) + <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ :raw-html:`
` + `GridStat: + Python Embedding to read and + process ice cover + (pyresample) + <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ :raw-html:`
` + `GridStat: + Python Embedding for sea surface salinity + using level 3, 1 day composite obs + (pyresample) + <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ :raw-html:`
` + `GridStat: + Python Embedding for sea surface salinity + using level 3, 8 day mean obs + (pyresample) + <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ + * - pytest + - >=7.2.1 + - METcalcpy, :raw-html:`
` + METplotpy, :raw-html:`
` + METdataio + - https://github.com/pytest-dev/pytest/archive/5.2.1.tar.gz + - a mature full-featured :raw-html:`
` + Python testing tool that :raw-html:`
` + helps you write better :raw-html:`
` + programs + - + * - python-kaleido + - >=0.2.1 + - METcalcpy, :raw-html:`
` + METplotpy + - https://pypi.org/project/kaleido/ + - provides a low-level :raw-html:`
` + Python API that is :raw-html:`
` + designed to be used by :raw-html:`
` + high-level plotting :raw-html:`
` + libraries like Plotly + - + * - pyyaml + - >=6.0 + - METcalcpy, :raw-html:`
` + METplotpy, :raw-html:`
` + METdataio + - https://github.com/yaml/pyyaml + - a full-featured YAML :raw-html:`
` + framework for the Python :raw-html:`
` + programming language + - + * - scikit-image + - >=0.19.3 + - METcalcpy, :raw-html:`
` + METplotpy + - https://scikit-image.org + - a collection of :raw-html:`
` + algorithms for image :raw-html:`
` + processing + - + * - scikit-learn + - >=1.2.2 + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy + - https://github.com/scikit-learn/scikit-learn/releases + - Open Source library for :raw-html:`
` + Machine Learning in Python + - `GridStat: + Python Embedding to read and process SST + (scikit-learn) + <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ :raw-html:`
` + `GridStat: + Python Embedding to read and process ice cover + (scikit-learn) <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ :raw-html:`
` + `GridStat: + Python Embedding for sea surface salinity using level 3, + 1 day composite obs + (scikit-learn) + <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ :raw-html:`
` + `GridStat: + Python Embedding for sea surface salinity using level 3, + 8 day mean obs + (scikit-learn) + <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ + * - scipy + - >=1.9.3 + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy + - https://www.scipy.org/ + - wraps highly-optimized :raw-html:`
` + implementations written :raw-html:`
` + in low-level languages :raw-html:`
` + like Fortran, C, and C++ + - `Blocking Calculation: + ERA RegridDataPlane, + PcpCombine, and + Blocking python code + (scipy) + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_Blocking.html>`_ :raw-html:`
` + `WeatherRegime Calculation: + RegridDataPlane, PcpCombine, and WeatherRegime python code + (scipy) + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` + `UserScript: + Make OMI plot from calculated MJO indices with ERA obs only + (obs only) (scipy) + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_OMI.html>`__ :raw-html:`
` + `WeatherRegime Calculation: + GFS and ERA RegridDataPlane, + PcpCombine, and + WeatherRegime python code + (scipy) + <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ :raw-html:`
` + `Blocking Calculation: + GFS and ERA RegridDataPlane, + PcpCombine, and + Blocking python code + (scipy) + <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking.html>`_ :raw-html:`
` + `UserScript: + Make a Phase Diagram plot from input RMM or OMI + (scipy) + <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`__ :raw-html:`
` + `UserScript: + Make OMI plot from calculated MJO indices with ERA obs and GFS fcst + (scipy) + <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ :raw-html:`
` + `UserScript: + Make RMM plots from calculated MJO indices + (scipy) + <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ + * - sklearn + - + - METplus wrappers + - https://www.kite.com/python/docs/sklearn + - Simple and efficient :raw-html:`
` + tools for predictive :raw-html:`
` + data analysis + - `WeatherRegime Calculation: + RegridDataPlane, PcpCombine, and WeatherRegime python code + (sklearn) + <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` + `WeatherRegime Calculation: + GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code + (sklearn) + <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ + * - xarray + - >=2023.1.0 + - METplus wrappers, :raw-html:`
` + METcalcpy, :raw-html:`
` + METplotpy + - https://xarray.pydata.org/en/v0.17.0/ + - makes working with :raw-html:`
` + labelled :raw-html:`
` + multi-dimensional arrays :raw-html:`
` + simple, efficient, :raw-html:`
` + and fun + - For using MET Python embedding functionality in use cases + * - xesmf + - + - METplus wrappers + - NOTE: The xesmf package :raw-html:`
` + will not be installed :raw-html:`
` + on WCOSS2 and there is :raw-html:`
` + an open GitHub issue to :raw-html:`
` + replace the package in :raw-html:`
` + the use case that uses it: :raw-html:`
` + https://github.com/dtcenter/METplus/issues/1314 + - for regridding + - `PlotDataPlane: + Python Embedding of + tripolar coordinate file + (xesmf) + <../generated/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.html>`_ + * - yaml + - + - METcalcpy, :raw-html:`
` + METplotpy + - https://pypi.org/project/PyYAML/ + - to load, read, and write :raw-html:`
` + YAML files with PyYAML + - + diff --git a/docs/Users_Guide/installation.rst b/docs/Users_Guide/installation.rst index 3910bdca95..5a08a47937 100644 --- a/docs/Users_Guide/installation.rst +++ b/docs/Users_Guide/installation.rst @@ -61,6 +61,8 @@ The following software is required to run METplus Wrappers: - convert (ImageMagick) utility - if generating images from the Postscript output +.. _python_package_requirements: + Python Package Requirements --------------------------- From aa904193eb7fc98d81593fbf8a7caa35eb3092b1 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 22 Jan 2024 13:17:30 -0700 Subject: [PATCH 34/47] Per #2463, adding to index.rst --- docs/Users_Guide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Users_Guide/index.rst b/docs/Users_Guide/index.rst index e5afd2f3df..345ec91e1e 100644 --- a/docs/Users_Guide/index.rst +++ b/docs/Users_Guide/index.rst @@ -88,7 +88,7 @@ is sponsored by NSF. glossary references statistics_list - + appendixA .. Indices and tables ================== From 3b4d5644a1bcfea94943e3f80981b09635ca0a52 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 22 Jan 2024 13:52:55 -0700 Subject: [PATCH 35/47] Per #2463, reworded language and updated Python 3.8 reference --- docs/Users_Guide/appendixA.rst | 8 +++----- docs/Users_Guide/overview.rst | 15 +++++++++------ 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/Users_Guide/appendixA.rst b/docs/Users_Guide/appendixA.rst index 7dd6ac5733..85392cc81c 100644 --- a/docs/Users_Guide/appendixA.rst +++ b/docs/Users_Guide/appendixA.rst @@ -1,7 +1,5 @@ .. _components_python_packages: -#.. _python_requirements_table: - ********************************************* Appendix A METplus Components Python Packages ********************************************* @@ -13,11 +11,11 @@ The information below is intended to be an overview of the Python package requirements for METplus (including use cases), MET Python Embedding, METcalcpy, METplotpy, and METdataio. -.. note:: Many of the Python packages listed below are OPTIONAL and not required. +.. note:: Many of the Python packages listed below are **OPTIONAL** and not required. For information regarding the Python package requirements for each of the -METplus components, please see the documentation for the desired METplus -component listed below. Please note that the documentation for the METplus +METplus components, see the documentation links below for the desired +METplus component. Please note that the documentation for the METplus Use Cases lists the required Python packages in the individual Use Cases documentation. diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 871745f448..04ae0fefbc 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -41,11 +41,13 @@ researchers to test their own enhancements to models and providing a capability for the DTC to evaluate the strengths and weaknesses of advances in NWP prior to operational implementation. -METplus Wrappers will also be available to DTC visitors and the NOAA Unified Forecast System (UFS) and NCAR System for Integrated Modeling of the Atmosphere (SIMA) modeling communities for testing and evaluation of new model capabilities, -applications in new environments, and so on. The METplus Wrappers -release schedule is coincident with the MET release schedule and the -METplus Wrappers major release number is six less than the MET major -release number (e.g. MET 8.X is released with METplus Wrappers 2.X). +METplus Wrappers will also be available to DTC visitors and the NOAA +Unified Forecast System (UFS) and NCAR System for Integrated Modeling +of the Atmosphere (SIMA) modeling communities for testing and evaluation +of new model capabilities, applications in new environments, and so on. +The METplus Wrappers release schedule is coincident with the MET release +schedule and the METplus Wrappers major release number is six less than +the MET major release number (e.g. MET 8.X is released with METplus Wrappers 2.X). METplus Wrappers goals and design philosophy ============================================ @@ -67,7 +69,8 @@ their verification environments. Wrappers can be run individually, or as a group of wrappers that represent a sequence of MET processes. New wrappers can readily be added to the METplus Wrappers package due to this modular design. Currently, METplus Wrappers can easily be applied -by any user on their own computer platform that supports Python 3.8. We have deprecated support to Python 2.7. +by any user on their own computer platform that supports Python 3.10. +We have deprecated support to Python 2.7. The METplus Wrappers code and documentation is maintained by the DTC in Boulder, Colorado. METplus Wrappers is freely available to the modeling, From 24e621a2b73f7e49122787e32a5c20dfbeae179d Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 22 Jan 2024 14:04:24 -0700 Subject: [PATCH 36/47] Per #2463, fixing errors --- docs/Users_Guide/appendixA.rst | 2 +- docs/Users_Guide/overview.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Users_Guide/appendixA.rst b/docs/Users_Guide/appendixA.rst index 85392cc81c..fcc2483eb7 100644 --- a/docs/Users_Guide/appendixA.rst +++ b/docs/Users_Guide/appendixA.rst @@ -111,7 +111,7 @@ METplus Components Python Packages Empirical orthogonal functions analysis of spatial-temporal data Use Cases: - | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ .. dropdown:: h5py diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 04ae0fefbc..6a10cc67ce 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -175,7 +175,7 @@ METplus Components Python Requirements Empirical orthogonal functions analysis of spatial-temporal data Use Cases: - | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` + | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ .. dropdown:: h5py From c791efd0883eaf2054465db900cecfc068fd4c49 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 23 Jan 2024 11:06:31 -0700 Subject: [PATCH 37/47] Per #2463, made updates based on feedback at the METplus Engineering meeting. --- docs/Users_Guide/appendixA.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Users_Guide/appendixA.rst b/docs/Users_Guide/appendixA.rst index fcc2483eb7..894d4ce419 100644 --- a/docs/Users_Guide/appendixA.rst +++ b/docs/Users_Guide/appendixA.rst @@ -7,11 +7,11 @@ Appendix A METplus Components Python Packages Overview ======== -The information below is intended to be an overview of the Python package -requirements for METplus (including use cases), MET Python Embedding, -METcalcpy, METplotpy, and METdataio. - -.. note:: Many of the Python packages listed below are **OPTIONAL** and not required. +.. note:: The information below is a union of the Python package requirements + across the following METplus components: METplus (including use + cases), MET Python Embedding, METcalcpy, METplotpy, and METdataio. + Many of the Python packages listed below are **OPTIONAL** and not + required. For information regarding the Python package requirements for each of the METplus components, see the documentation links below for the desired From db2f4ab029d7df33b8069b19219b2a14d9bbbf96 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 23 Feb 2024 15:31:18 -0700 Subject: [PATCH 38/47] removing tables, changing most METplus wrappers, version numbers. --- docs/Users_Guide/appendixA.rst | 654 +---------------- docs/Users_Guide/installation.rst | 4 +- docs/Users_Guide/overview.rst | 1144 +---------------------------- docs/conf.py | 4 + 4 files changed, 29 insertions(+), 1777 deletions(-) diff --git a/docs/Users_Guide/appendixA.rst b/docs/Users_Guide/appendixA.rst index 894d4ce419..0adda81b61 100644 --- a/docs/Users_Guide/appendixA.rst +++ b/docs/Users_Guide/appendixA.rst @@ -27,11 +27,12 @@ documentation. * `METviewer Python Package Requirements `_ * `METexpress Python Package Requirements `_ +.. _metplus_components_python_packages: METplus Components Python Packages ================================== -.. dropdown:: Python 3.10.4+ +.. dropdown:: Python |python_version| + METplus Component: | METplus wrappers, @@ -42,7 +43,7 @@ METplus Components Python Packages .. dropdown:: cartopy >=0.21.1 METplus Component: - | METplus wrappers, + | Select METplus Use Cases, | METcalcpy, | METplotpy @@ -59,7 +60,7 @@ METplus Components Python Packages .. dropdown:: cfgrib METplus Component: - METplus wrappers + Select METplus Use Cases Source: https://pypi.org/project/cfgrib/ @@ -100,7 +101,7 @@ METplus Components Python Packages .. dropdown:: eofs METplus Component: - | METplus wrappers, + | Select METplus Use Cases, | METcalcpy, | METplotpy @@ -117,7 +118,7 @@ METplus Components Python Packages .. dropdown:: h5py METplus Component: - METplus wrappers + Select METplus Use Cases Source: https://github.com/h5py/h5py @@ -168,7 +169,7 @@ METplus Components Python Packages .. dropdown:: matplotlib >=3.6.3 METplus Component: - | METplus wrappers, + | Select METplus Use Cases, | METcalcpy, | METplotpy @@ -189,7 +190,7 @@ METplus Components Python Packages .. dropdown:: metcalcpy METplus Component: - | METplus wrappers, + | Select METplus Use Cases, | METcalcpy, | METplotpy @@ -210,14 +211,14 @@ METplus Components Python Packages .. dropdown:: metplotpy METplus Component: - METplus wrappers + Select METplus Use Cases Source: https://github.com/dtcenter/METplotpy/releases Description: Contains packages for plotting in METplus as stand-alone, or part of METplus use case, - METplus wrappers, METexpress, or METviewer + Select METplus Use Cases, METexpress, or METviewer Use Case: | `UserScript: Make a Hovmoeller plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ @@ -228,7 +229,7 @@ METplus Components Python Packages .. dropdown:: metpy >=1.4.0 METplus Component: - METplus wrappers + Select METplus Use Cases Source: https://www.unidata.ucar.edu/software/metpy/ @@ -255,7 +256,7 @@ METplus Components Python Packages .. dropdown:: netCDF4 >=1.6.2 METplus Component: - | METplus wrappers, + | Select METplus Use Cases, | METcalcpy, | METplotpy @@ -272,7 +273,7 @@ METplus Components Python Packages .. dropdown:: numpy >=1.24.2 METplus Component: - | METplus wrappers, + | Select METplus Use Cases, | METcalcpy, | METplotpy, | METdataio @@ -290,7 +291,7 @@ METplus Components Python Packages .. dropdown:: pandas >=1.5.2 METplus Component: - | METplus wrappers, + | Select METplus Use Cases, | METcalcpy, | METplotpy, | METdataio @@ -352,7 +353,7 @@ METplus Components Python Packages .. dropdown:: pylab METplus Component: - METplus wrappers + Select METplus Use Cases Source: https://pypi.org/project/matplotlib/ @@ -381,7 +382,7 @@ METplus Components Python Packages .. dropdown:: pyproj >=2.3.1 METplus Component: - METplus wrappers + Select METplus Use Cases Source: https://github.com/pyproj4/pyproj/archive/v2.3.1rel.tar.gz @@ -395,7 +396,7 @@ METplus Components Python Packages .. dropdown:: pyresample METplus Component: - METplus wrappers + Select METplus Use Cases METplus Component: https://github.com/pytroll/pyresample @@ -462,7 +463,7 @@ METplus Components Python Packages .. dropdown:: scikit-learn >=1.2.2 METplus Component: - | METplus wrappers, + | Select METplus Use Cases, | METcalcpy, | METplotpy @@ -481,7 +482,7 @@ METplus Components Python Packages .. dropdown:: scipy >=1.9.3 METplus Component: - | METplus wrappers, + | Select METplus Use Cases, | METcalcpy, | METplotpy @@ -504,7 +505,7 @@ METplus Components Python Packages .. dropdown:: sklearn METplus Component: - METplus wrappers + Select METplus Use Cases Source: https://www.kite.com/python/docs/sklearn @@ -520,7 +521,7 @@ METplus Components Python Packages .. dropdown:: xarray >=2023.1.0 METplus Component: - | METplus wrappers, + | Select METplus Use Cases, | METcalcpy, | METplotpy @@ -536,7 +537,7 @@ METplus Components Python Packages .. dropdown:: xesmf METplus Component: - METplus wrappers + Select METplus Use Cases Source: NOTE: The xesmf package will not be installed on WCOSS2 and there is an open GitHub issue to @@ -562,614 +563,3 @@ METplus Components Python Packages Description: To load, read, and write YAML files with PyYAML -.. Number of characters per line: - Name - no more that 13 characters - Version - no more than 6 characters - METplus component - no more than 17 characters - Source - no more than 8 characters - Description - no more than 22 (was 20) characters - Use Cases - no more than 17 (was 10) characters - -.. role:: raw-html(raw) - :format: html - -.. list-table:: METplus Components Python Requirements - :widths: auto - :header-rows: 1 - - * - Name - - Version - - METplus Component - - Source - - Description - - Use Cases (only applicable for METplus wrappers component)(followed by - python package name) - * - Python 3.10.4+ - - - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - - - - - - * - cartopy - - >=0.21.1 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://scitools.org.uk/cartopy/docs/latest/ - - Designed for :raw-html:`
` - geospatial data :raw-html:`
` - processing in :raw-html:`
` - order to produce :raw-html:`
` - maps and other :raw-html:`
` - geospatial data :raw-html:`
` - analyses - - `TCGen: Genesis Density Function (GDF) - and Track Density Function (TDF) - (cartopy) - <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ :raw-html:`
` - `CyclonePlotter: Extra-TC Tracker - and Plotting Capabilities - (cartopy) - <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ - * - cfgrib - - - - METplus wrappers - - https://pypi.org/project/cfgrib/ - - map GRIB files :raw-html:`
` - to the NetCDF :raw-html:`
` - Common Data Model :raw-html:`
` - following the :raw-html:`
` - CF Convention :raw-html:`
` - using ecCodes - - `Multi_Tool: - Feature Relative by Lead using - Multiple User-Defined Fields - (cfgrib) - <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ - * - cmocean - - - - METcalcpy, :raw-html:`
` - METplotpy - - https://pypi.org/project/cmocean/ - - contains colormaps :raw-html:`
` - for commonly-used :raw-html:`
` - oceanographic variables - - - * - dateutil - - >=2.8.2 - - METplus wrappers - - https://github.com/dateutil/dateutil/releases - - provides powerful :raw-html:`
` - extensions to the :raw-html:`
` - standard datetime :raw-html:`
` - module - - Most - * - eofs - - - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://pypi.org/project/eofs/ - - empirical orthogonal :raw-html:`
` - functions analysis of :raw-html:`
` - spatial-temporal data - - `WeatherRegime Calculation: - RegridDataPlane, - PcpCombine, - and WeatherRegime python code - (eofs) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` - `WeatherRegime Calculation: - GFS and ERA RegridDataPlane, - PcpCombine, and - WeatherRegime python code - (eofs) - <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - * - h5py - - - - METplus wrappers - - https://github.com/h5py/h5py - - Pythonic interface :raw-html:`
` - to the HDF5 :raw-html:`
` - binary data format - - `PCPCombine: - Python Embedding Use Case - (h5py) - <../generated/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.html>`_ - * - imutils - - >=0.5.4 - - METplotpy :raw-html:`
` - - https://pypi.org/project/imutils/ - - A series of convenience :raw-html:`
` - functions to make basic :raw-html:`
` - image processing :raw-html:`
` - functions such as :raw-html:`
` - translation, rotation, :raw-html:`
` - resizing, skeletonization, :raw-html:`
` - displaying Matplotlib :raw-html:`
` - images, sorting contours, :raw-html:`
` - detecting edges, :raw-html:`
` - and much more easier - - - * - imageio - - - - METcalcpy, :raw-html:`
` - METplotpy - - https://pypi.org/project/imageio/ - - provides an easy :raw-html:`
` - interface to read :raw-html:`
` - and write a wide :raw-html:`
` - range of image data, :raw-html:`
` - including animated :raw-html:`
` - images, volumetric data, :raw-html:`
` - and scientific formats - - - * - lxml - - >=4.9.1 - - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://pypi.org/project/lxml/ - - a Pythonic binding for :raw-html:`
` - the C libraries :raw-html:`
` - libxml2 and libxslt - - - * - matplotlib - - >=3.6.3 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://matplotlib.org/stable/users/installing/index.html - - a comprehensive library :raw-html:`
` - for creating static, :raw-html:`
` - animated, and :raw-html:`
` - interactive visualizations - - `UserScript: - Make OMI plot from - calculated MJO indices with ERA obs only - (matplotlib) - <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_OMI.html>`__ :raw-html:`
` - `TCGen: - Genesis Density Function (GDF) - and Track Density Function (TDF) - (matplotlib) - <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ :raw-html:`
` - `UserScript: - Make a Phase Diagram plot - from input RMM or OMI - (matplotlib) - <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ :raw-html:`
` - `UserScript: - Make OMI plot from - calculated MJO indices with ERA obs and GFS fcst - (matplotlib) - <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ :raw-html:`
` - `UserScript: - Make RMM plots from - calculated MJO indices - (matplotlib) - <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ :raw-html:`
` - `CyclonePlotter: - Extra-TC Tracker and - Plotting Capabilities - (matplotlib) - <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ :raw-html:`
` - * - metcalcpy - - - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://github.com/dtcenter/METcalcpy/releases - - a Python version of the :raw-html:`
` - statistics calculation :raw-html:`
` - functionality of :raw-html:`
` - METviewer, METexpress, :raw-html:`
` - plotting packages in :raw-html:`
` - METplotpy and is a :raw-html:`
` - stand-alone package for :raw-html:`
` - any other application - - `UserScript: - Make a Hovmoeller plot - (metcalcpy) - <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ :raw-html:`
` - `UserScript: - Compute Cross Spectra and Make a Plot - (metcalcpy) - <../generated/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.html>`__ :raw-html:`
` - `Grid-Stat: - Verification of TC forecasts - against merged TDR data - (metcalcpy) - <../generated/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.html>`_ :raw-html:`
` - `UserScript: - Calculate the Difficulty Index - (metcalcpy) - <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ :raw-html:`
` - `UserScript: - Make zonal and meridonial means - (metcalcpy) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_Stratosphere.html>`_ :raw-html:`
` - * - metplotpy - - - - METplus wrappers - - https://github.com/dtcenter/METplotpy/releases - - contains packages for :raw-html:`
` - plotting in METplus as :raw-html:`
` - stand-alone, or part of :raw-html:`
` - METplus use case, :raw-html:`
` - METplus wrappers, :raw-html:`
` - METexpress, :raw-html:`
` - or METviewer - - `UserScript: - Make a Hovmoeller plot - (metplotpy) - <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ :raw-html:`
` - `UserScript: - Compute Cross Spectra and Make a Plot - (metplotpy) - <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`__ :raw-html:`
` - `UserScript: - Calculate the Difficulty Index - (metplotpy) - <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ :raw-html:`
` - `TCGen: - Genesis Density Function (GDF) - and Track Density Function (TDF) - (metplotpy) - <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - * - metpy - - >=1.4.0 - - METplus wrappers - - https://www.unidata.ucar.edu/software/metpy/ - - a collection of tools :raw-html:`
` - in Python for reading, :raw-html:`
` - visualizing, and :raw-html:`
` - performing calculations :raw-html:`
` - with weather data - - `Multi_Tool: - Feature Relative by Lead using - Multiple User-Defined Fields - (metpy) - <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ - * - nc-time-axis - - 1.4 - - METplotpy :raw-html:`
` - stratosphere_diagnostics - - https://github.com/SciTools/nc-time-axis - - extension to cftime :raw-html:`
` - \**REQUIRES Python 3.7 - - - * - netCDF4 - - >=1.6.2 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://unidata.github.io/netcdf4-python/ - - a Python interface to :raw-html:`
` - the netCDF C library - - For using MET Python embedding functionality in use cases - * - numpy - - >=1.24.2 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://numpy.org/ - - NumPy offers :raw-html:`
` - comprehensive :raw-html:`
` - mathematical functions, :raw-html:`
` - random number generators, :raw-html:`
` - linear algebra routines, :raw-html:`
` - Fourier transforms, and more. - - For using MET Python embedding functionality in use cases - * - pandas - - >=1.5.2 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://pypi.org/project/pandas - - a fast, powerful, :raw-html:`
` - flexible and easy to use :raw-html:`
` - open source data analysis :raw-html:`
` - and manipulation tool, :raw-html:`
` - built on top of the :raw-html:`
` - Python programming :raw-html:`
` - language - - For using MET Python embedding functionality in use cases - * - pint - - >=0.20.1 - - METcalcpy - - https://github.com/hgrecco/pint - - Python package to define, :raw-html:`
` - operate and manipulate :raw-html:`
` - physical quantities - - - * - plotly - - >=5.13.0 - - METcalcpy, :raw-html:`
` - METplotpy - - https://github.com/plotly/plotly.py - - makes interactive, :raw-html:`
` - publication-quality graphs - - - * - pygrib - - - - METplus wrappers - - https://github.com/jswhit/pygrib - - for reading/writing :raw-html:`
` - GRIB files - - `Multi_Tool: - Feature Relative by Lead - using Multiple User-Defined Fields - (pygrib) - <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ :raw-html:`
` - `GridStat: - Cloud Fractions Using GFS - and ERA5 Data - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.html>`_ :raw-html:`
` - `GridStat: - Cloud Height with Neighborhood - and Probabilities - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstMPAS_obsERA5_cloudBaseHgt.html>`_ :raw-html:`
` - `GridStat: - Cloud Pressure and - Temperature Heights - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstGFS_obsSATCORPS_cloudTopPressAndTemp.html>`_ :raw-html:`
` - `GridStat: - Cloud Fractions Using GFS - and MERRA2 Data - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.html>`_ :raw-html:`
` - `GridStat: - Cloud Fractions Using MPAS - and SatCORPS Data - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac.html>`_ :raw-html:`
` - `GridStat: - Cloud Fractions Using MPAS - and MERRA2 Data - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstMPAS_obsMERRA2_lowAndTotalCloudFrac.html>`_ - * - pylab - - - - METplus wrappers - - https://pypi.org/project/matplotlib/ - - a convenience module :raw-html:`
` - that bulk imports :raw-html:`
` - matplotlib.pyplot (for :raw-html:`
` - plotting) and NumPy (for :raw-html:`
` - Mathematics and working :raw-html:`
` - with arrays) in a :raw-html:`
` - single name space - - `WeatherRegime Calculation: - RegridDataPlane, PcpCombine, - and WeatherRegime python code - (pylab) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` - `WeatherRegime Calculation: - GFS and ERA RegridDataPlane, - PcpCombine, and WeatherRegime - python code - (pylab) - <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - * - pymysql - - >=1.0.2 - - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://pypi.org/project/psutil/ - - a pure-Python MySQL :raw-html:`
` - client library, :raw-html:`
` - based on PEP 249 - - - * - pyproj - - >=2.3.1 - - METplus wrappers - - https://github.com/pyproj4/pyproj/archive/v2.3.1rel.tar.gz - - Python interface to PROJ :raw-html:`
` - (cartographic projections and :raw-html:`
` - coordinate transformations library) - - `GridStat: - Python Embedding to read - and process ice cover - (pyproj) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ - * - pyresample - - - - METplus wrappers - - https://github.com/pytroll/pyresample - - for resampling geospatial :raw-html:`
` - image data - - `GridStat: - Python Embedding to read and - process SST - (pyresample) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ :raw-html:`
` - `GridStat: - Python Embedding to read and - process ice cover - (pyresample) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ :raw-html:`
` - `GridStat: - Python Embedding for sea surface salinity - using level 3, 1 day composite obs - (pyresample) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ :raw-html:`
` - `GridStat: - Python Embedding for sea surface salinity - using level 3, 8 day mean obs - (pyresample) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ - * - pytest - - >=7.2.1 - - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://github.com/pytest-dev/pytest/archive/5.2.1.tar.gz - - a mature full-featured :raw-html:`
` - Python testing tool that :raw-html:`
` - helps you write better :raw-html:`
` - programs - - - * - python-kaleido - - >=0.2.1 - - METcalcpy, :raw-html:`
` - METplotpy - - https://pypi.org/project/kaleido/ - - provides a low-level :raw-html:`
` - Python API that is :raw-html:`
` - designed to be used by :raw-html:`
` - high-level plotting :raw-html:`
` - libraries like Plotly - - - * - pyyaml - - >=6.0 - - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://github.com/yaml/pyyaml - - a full-featured YAML :raw-html:`
` - framework for the Python :raw-html:`
` - programming language - - - * - scikit-image - - >=0.19.3 - - METcalcpy, :raw-html:`
` - METplotpy - - https://scikit-image.org - - a collection of :raw-html:`
` - algorithms for image :raw-html:`
` - processing - - - * - scikit-learn - - >=1.2.2 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://github.com/scikit-learn/scikit-learn/releases - - Open Source library for :raw-html:`
` - Machine Learning in Python - - `GridStat: - Python Embedding to read and process SST - (scikit-learn) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ :raw-html:`
` - `GridStat: - Python Embedding to read and process ice cover - (scikit-learn) <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ :raw-html:`
` - `GridStat: - Python Embedding for sea surface salinity using level 3, - 1 day composite obs - (scikit-learn) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ :raw-html:`
` - `GridStat: - Python Embedding for sea surface salinity using level 3, - 8 day mean obs - (scikit-learn) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ - * - scipy - - >=1.9.3 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://www.scipy.org/ - - wraps highly-optimized :raw-html:`
` - implementations written :raw-html:`
` - in low-level languages :raw-html:`
` - like Fortran, C, and C++ - - `Blocking Calculation: - ERA RegridDataPlane, - PcpCombine, and - Blocking python code - (scipy) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_Blocking.html>`_ :raw-html:`
` - `WeatherRegime Calculation: - RegridDataPlane, PcpCombine, and WeatherRegime python code - (scipy) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` - `UserScript: - Make OMI plot from calculated MJO indices with ERA obs only - (obs only) (scipy) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_OMI.html>`__ :raw-html:`
` - `WeatherRegime Calculation: - GFS and ERA RegridDataPlane, - PcpCombine, and - WeatherRegime python code - (scipy) - <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ :raw-html:`
` - `Blocking Calculation: - GFS and ERA RegridDataPlane, - PcpCombine, and - Blocking python code - (scipy) - <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking.html>`_ :raw-html:`
` - `UserScript: - Make a Phase Diagram plot from input RMM or OMI - (scipy) - <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`__ :raw-html:`
` - `UserScript: - Make OMI plot from calculated MJO indices with ERA obs and GFS fcst - (scipy) - <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ :raw-html:`
` - `UserScript: - Make RMM plots from calculated MJO indices - (scipy) - <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ - * - sklearn - - - - METplus wrappers - - https://www.kite.com/python/docs/sklearn - - Simple and efficient :raw-html:`
` - tools for predictive :raw-html:`
` - data analysis - - `WeatherRegime Calculation: - RegridDataPlane, PcpCombine, and WeatherRegime python code - (sklearn) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` - `WeatherRegime Calculation: - GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code - (sklearn) - <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - * - xarray - - >=2023.1.0 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://xarray.pydata.org/en/v0.17.0/ - - makes working with :raw-html:`
` - labelled :raw-html:`
` - multi-dimensional arrays :raw-html:`
` - simple, efficient, :raw-html:`
` - and fun - - For using MET Python embedding functionality in use cases - * - xesmf - - - - METplus wrappers - - NOTE: The xesmf package :raw-html:`
` - will not be installed :raw-html:`
` - on WCOSS2 and there is :raw-html:`
` - an open GitHub issue to :raw-html:`
` - replace the package in :raw-html:`
` - the use case that uses it: :raw-html:`
` - https://github.com/dtcenter/METplus/issues/1314 - - for regridding - - `PlotDataPlane: - Python Embedding of - tripolar coordinate file - (xesmf) - <../generated/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.html>`_ - * - yaml - - - - METcalcpy, :raw-html:`
` - METplotpy - - https://pypi.org/project/PyYAML/ - - to load, read, and write :raw-html:`
` - YAML files with PyYAML - - - diff --git a/docs/Users_Guide/installation.rst b/docs/Users_Guide/installation.rst index 5a08a47937..866060eabd 100644 --- a/docs/Users_Guide/installation.rst +++ b/docs/Users_Guide/installation.rst @@ -43,9 +43,9 @@ Software Requirements The following software is required to run METplus Wrappers: -- Python 3.8.6 or above +- Python |python_version| or above -- MET version 11.0.0 or above - +- MET version |met_version| or above - For information on installing MET please see the `Software Installation/Getting Started `_ section of the MET User's Guide. diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 6a10cc67ce..fadc5a751a 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -93,1150 +93,8 @@ METplus functionality. METplus Components Python Requirements ====================================== -**Testing dropdown menus:** +See :ref:`metplus_components_python_packages` -.. dropdown:: Python 3.10.4+ - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy, - | METdataio - -.. dropdown:: cartopy >=0.21.1 - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy - - Source: - https://scitools.org.uk/cartopy/docs/latest/ - - Description: - Designed for geospatial data processing in order to produce maps and other geospatial data analyses - - Use Cases: - | `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - | `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ - -.. dropdown:: cfgrib - - METplus Component: - METplus wrappers - - Source: - https://pypi.org/project/cfgrib/ - - Description: - Map GRIB files to the NetCDF Common Data Model following the CF Convention using ecCodes - - Use Cases: - `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields - <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ - -.. dropdown:: cmocean - - METplus Component: - | METcalcpy, - | METplotpy - - Source: - https://pypi.org/project/cmocean/ - - Description: - Contains colormaps for commonly-used oceanographic variables - -.. dropdown:: dateutil >=2.8.2 - - METplus Component: - METplus wrappers - - Source: - https://github.com/dateutil/dateutil/releases - - Description: - Provides powerful extensions to the standard datetime module - - Use Cases: - Most - -.. dropdown:: eofs - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy - - Source: - https://pypi.org/project/eofs/ - - Description: - Empirical orthogonal functions analysis of spatial-temporal data - - Use Cases: - | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ - | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - -.. dropdown:: h5py - - METplus Component: - METplus wrappers - - Source: - https://github.com/h5py/h5py - - Description: - Pythonic interface to the HDF5 binary data format - - Use Case: - `PCPCombine: Python Embedding Use Case <../generated/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.html>`_ - -.. dropdown:: imutils >=0.5.4 - - METplus Component: - METplotpy - - Source: - https://pypi.org/project/imutils/ - - Description: - A series of convenience functions to make basic image processing functions such as translation, rotation, resizing, skeletonization, displaying Matplotlib images, sorting contours, detecting edges, and much more easier - -.. dropdown:: imageio - - METplus Component: - | METcalcpy, - | METplotpy - - Source: - https://pypi.org/project/imageio/ - - Description: - Provides an easy interface to read and write a wide range of image data, including animated - images, volumetric data, and scientific formats - -.. dropdown:: lxml >=4.9.1 - - METplus Component: - | METcalcpy, - | METplotpy, - | METdataio - - Source: - https://pypi.org/project/lxml/ - - Description: - A Pythonic binding for the C libraries libxml2 and libxslt - -.. dropdown:: matplotlib >=3.6.3 - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy - - Source: - https://matplotlib.org/stable/users/installing/index.html - - Description: - A comprehensive library for creating static, animated, and interactive visualizations - - Use Case: - | `UserScript: Make OMI plot from calculated MJO indices with ERA obs only <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_OMI.html>`__ - | `TCGen: Genesis Density Function and Track Density Function <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - | `UserScript: Make a Phase Diagram plot from input RMM or OMI <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ - | `UserScript: Make OMI plot from calculated MJO indices with ERA obs and GFS fcst <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ - | `UserScript: Make RMM plots from calculated MJO indices <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ - | `CyclonePlotter: Extra-TC Tracker and Plotting Capabilities <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ - -.. dropdown:: metcalcpy - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy - - Source: - https://github.com/dtcenter/METcalcpy/releases - - Description: - A Python version of the statistics calculation functionality of METviewer, METexpress, - plotting packages in METplotpy and is a stand-alone package for any other application - - Use Case: - | `UserScript: Make a Hovmoeller plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ - | `UserScript: Compute Cross Spectra and Make a Plot <../generated/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.html>`__ - | `Grid-Stat: Verification of TC forecasts against merged TDR data <../generated/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.html>`_ - | `UserScript: Calculate the Difficulty Index <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ - | `UserScript: Make zonal and meridonial means <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_Stratosphere.html>`_ - -.. dropdown:: metplotpy - - METplus Component: - METplus wrappers - - Source: - https://github.com/dtcenter/METplotpy/releases - - Description: - Contains packages for plotting in METplus as stand-alone, or part of METplus use case, - METplus wrappers, METexpress, or METviewer - - Use Case: - | `UserScript: Make a Hovmoeller plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ - | `UserScript: Compute Cross Spectra and Make a Plot <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`__ - | `UserScript: Calculate the Difficulty Index <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ - | `TCGen: Genesis Density Function (GDF) and Track Density Function (TDF) <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - -.. dropdown:: metpy >=1.4.0 - - METplus Component: - METplus wrappers - - Source: - https://www.unidata.ucar.edu/software/metpy/ - - Description: - A collection of tools in Python for reading, visualizing, and performing calculations - with weather data - - Use Case: - `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ - -.. dropdown:: nc-time-axis 1.4 - - METplus Component: - | METplotpy - | stratosphere_diagnostics - - Source: - | https://github.com/SciTools/nc-time-axis - - Description: - Extension to cftime - \**REQUIRES Python 3.7** - -.. dropdown:: netCDF4 >=1.6.2 - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy - - Source: - https://unidata.github.io/netcdf4-python/ - - Description: - - A Python interface to the netCDF C library - - Use Case: - For using MET Python embedding functionality in use cases - -.. dropdown:: numpy >=1.24.2 - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy, - | METdataio - - Source: - https://numpy.org/ - - Description: - NumPy offers comprehensive mathematical functions, random number generators, - linear algebra routines, Fourier transforms, and more. - - Use Case: - For using MET Python embedding functionality in use cases - -.. dropdown:: pandas >=1.5.2 - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy, - | METdataio - - Source: - https://pypi.org/project/pandas - - Description: - A fast, powerful, flexible and easy to use open source data analysis - and manipulation tool, built on top of the Python programming language - - Use Case: - For using MET Python embedding functionality in use cases - -.. dropdown:: pint >=0.20.1 - - METplus Component: - METcalcpy - - Source: - https://github.com/hgrecco/pint - - Description: - Python package to define, operate and manipulate physical quantities - -.. dropdown:: plotly >=5.13.0 - - METplus Component: - | METcalcpy, - | METplotpy - - Source: - https://github.com/plotly/plotly.py - - Description: - Makes interactive, publication-quality graphs - -.. dropdown:: pygrib - - METplus Component: - METplus wrappers - - Source: - https://github.com/jswhit/pygrib - - Description: - For reading/writing GRIB files - - Use Case: - | `Multi_Tool: Feature Relative by Lead using Multiple User-Defined Fields <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ - | `GridStat: Cloud Fractions Using GFS and ERA5 Data <../generated/model_applications/clouds/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.html>`_ - | `GridStat: Cloud Height with Neighborhood and Probabilities <../generated/model_applications/clouds/GridStat_fcstMPAS_obsERA5_cloudBaseHgt.html>`_ - | `GridStat: Cloud Pressure and Temperature Heights <../generated/model_applications/clouds/GridStat_fcstGFS_obsSATCORPS_cloudTopPressAndTemp.html>`_ - | `GridStat: Cloud Fractions Using GFS and MERRA2 Data <../generated/model_applications/clouds/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.html>`_ - | `GridStat: Cloud Fractions Using MPAS and SatCORPS Data <../generated/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac.html>`_ - | `GridStat: Cloud Fractions Using MPAS and MERRA2 Data <../generated/model_applications/clouds/GridStat_fcstMPAS_obsMERRA2_lowAndTotalCloudFrac.html>`_ - - -.. dropdown:: pylab - - METplus Component: - METplus wrappers - - Source: - https://pypi.org/project/matplotlib/ - - Description: - A convenience module that bulk imports matplotlib.pyplot (for plotting) and NumPy (for - Mathematics and working with arrays) in a single name space - - Use Case: - | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ - | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - -.. dropdown:: pymysql >=1.0.2 - - METplus Component: - | METcalcpy, - | METplotpy, - | METdataio - - Source: - https://pypi.org/project/psutil/ - - Description: - A pure-Python MySQL client library, based on PEP 249 - -.. dropdown:: pyproj >=2.3.1 - - METplus Component: - METplus wrappers - - Source: - https://github.com/pyproj4/pyproj/archive/v2.3.1rel.tar.gz - - Description: - Python interface to PROJ (cartographic projections and coordinate transformations library) - - Use Case: - | `GridStat: Python Embedding to read and process ice cover <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ - -.. dropdown:: pyresample - - METplus Component: - METplus wrappers - - METplus Component: - https://github.com/pytroll/pyresample - - Description: - For resampling geospatial image data - - Use Case: - | `GridStat: Python Embedding to read and process SST <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ - | `GridStat: Python Embedding to read and process ice cover <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ - | `GridStat: Python Embedding for sea surface salinity using level 3, 1 day composite obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ - | `GridStat: Python Embedding for sea surface salinity using level 3, 8 day mean obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ - -.. dropdown:: pytest >=7.2.1 - - METplus Component: - | METcalcpy, - | METplotpy, - | METdataio - - Source: - https://github.com/pytest-dev/pytest/archive/5.2.1.tar.gz - - Description: - A mature full-featured Python testing tool that helps to write better programs - -.. dropdown:: python-kaleido >=0.2.1 - - METplus Component: - | METcalcpy, - | METplotpy - - Source: - https://pypi.org/project/kaleido/ - - Description: - Provides a low-level Python API that is designed to be used by high-level plotting libraries like Plotly - -.. dropdown:: pyyaml >=6.0 - - METplus Component: - | METcalcpy, - | METplotpy, - | METdataio - - Source: - https://github.com/yaml/pyyaml - - Description: - A full-featured YAML framework for the Python programming language - -.. dropdown:: scikit-image >=0.19.3 - - METplus Component: - | METcalcpy, - | METplotpy - - Source: - https://scikit-image.org - - Description: - A collection of algorithms for image processing - -.. dropdown:: scikit-learn >=1.2.2 - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy - - Source: - https://github.com/scikit-learn/scikit-learn/releases - - Description: - Open Source library for Machine Learning in Python - - Use Case: - | `GridStat: Python Embedding to read and process SST <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ - | `GridStat: Python Embedding to read and process ice cover <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ - | `GridStat: Python Embedding for sea surface salinity using level 3, 1 day composite obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ - | `GridStat: Python Embedding for sea surface salinity using level 3, 8 day mean obs <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ - -.. dropdown:: scipy >=1.9.3 - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy - - Source: - https://www.scipy.org/ - - Description: - Wraps highly-optimized implementations written in low-level languages like Fortran, C, and C++ - - Use Case: - | `Blocking Calculation: ERA RegridDataPlane, PcpCombine, and Blocking python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_Blocking.html>`_ - | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ - | `UserScript: Make OMI plot from calculated MJO indices with ERA obs only <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_OMI.html>`__ - | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - | `Blocking Calculation: GFS and ERA RegridDataPlane, PcpCombine, and Blocking python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking.html>`_ - | `UserScript: Make a Phase Diagram plot from input RMM or OMI <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`__ - | `UserScript: Make OMI plot from calculated MJO indices with ERA obs and GFS fcst <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ - | `UserScript: Make RMM plots from calculated MJO indices <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ - -.. dropdown:: sklearn - - METplus Component: - METplus wrappers - - Source: - https://www.kite.com/python/docs/sklearn - - Description: - Simple and efficient tools for predictive data analysis - - Description: - | `WeatherRegime Calculation: RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ - | `WeatherRegime Calculation: GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - - -.. dropdown:: xarray >=2023.1.0 - - METplus Component: - | METplus wrappers, - | METcalcpy, - | METplotpy - - Source: - https://xarray.pydata.org/en/v0.17.0/ - - Description: - Makes working with labelled multi-dimensional arrays simple, efficient, and fun - - Use Case: - For using MET Python embedding functionality in use cases - -.. dropdown:: xesmf - - METplus Component: - METplus wrappers - - Source: - NOTE: The xesmf package will not be installed on WCOSS2 and there is an open GitHub issue to - replace the package in the use case that uses it: - https://github.com/dtcenter/METplus/issues/1314 - - Description: - For regridding - - Use Case: - `PlotDataPlane: Python Embedding of tripolar coordinate file <../generated/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.html>`_ - - -.. dropdown:: yaml - - METplus Component: - | METcalcpy, - | METplotpy - - Source: - https://pypi.org/project/PyYAML/ - - Description: - To load, read, and write YAML files with PyYAML - -.. Number of characters per line: - Name - no more that 13 characters - Version - no more than 6 characters - METplus component - no more than 17 characters - Source - no more than 8 characters - Description - no more than 22 (was 20) characters - Use Cases - no more than 17 (was 10) characters - -.. role:: raw-html(raw) - :format: html - -.. list-table:: METplus Components Python Requirements - :widths: auto - :header-rows: 1 - - * - Name - - Version - - METplus Component - - Source - - Description - - Use Cases (only applicable for METplus wrappers component)(followed by - python package name) - * - Python 3.10.4+ - - - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - - - - - - * - cartopy - - >=0.21.1 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://scitools.org.uk/cartopy/docs/latest/ - - Designed for :raw-html:`
` - geospatial data :raw-html:`
` - processing in :raw-html:`
` - order to produce :raw-html:`
` - maps and other :raw-html:`
` - geospatial data :raw-html:`
` - analyses - - `TCGen: Genesis Density Function (GDF) - and Track Density Function (TDF) - (cartopy) - <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ :raw-html:`
` - `CyclonePlotter: Extra-TC Tracker - and Plotting Capabilities - (cartopy) - <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ - * - cfgrib - - - - METplus wrappers - - https://pypi.org/project/cfgrib/ - - map GRIB files :raw-html:`
` - to the NetCDF :raw-html:`
` - Common Data Model :raw-html:`
` - following the :raw-html:`
` - CF Convention :raw-html:`
` - using ecCodes - - `Multi_Tool: - Feature Relative by Lead using - Multiple User-Defined Fields - (cfgrib) - <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ - * - cmocean - - - - METcalcpy, :raw-html:`
` - METplotpy - - https://pypi.org/project/cmocean/ - - contains colormaps :raw-html:`
` - for commonly-used :raw-html:`
` - oceanographic variables - - - * - dateutil - - >=2.8.2 - - METplus wrappers - - https://github.com/dateutil/dateutil/releases - - provides powerful :raw-html:`
` - extensions to the :raw-html:`
` - standard datetime :raw-html:`
` - module - - Most - * - eofs - - - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://pypi.org/project/eofs/ - - empirical orthogonal :raw-html:`
` - functions analysis of :raw-html:`
` - spatial-temporal data - - `WeatherRegime Calculation: - RegridDataPlane, - PcpCombine, - and WeatherRegime python code - (eofs) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` - `WeatherRegime Calculation: - GFS and ERA RegridDataPlane, - PcpCombine, and - WeatherRegime python code - (eofs) - <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - * - h5py - - - - METplus wrappers - - https://github.com/h5py/h5py - - Pythonic interface :raw-html:`
` - to the HDF5 :raw-html:`
` - binary data format - - `PCPCombine: - Python Embedding Use Case - (h5py) - <../generated/met_tool_wrapper/PCPCombine/PCPCombine_python_embedding.html>`_ - * - imutils - - >=0.5.4 - - METplotpy :raw-html:`
` - - https://pypi.org/project/imutils/ - - A series of convenience :raw-html:`
` - functions to make basic :raw-html:`
` - image processing :raw-html:`
` - functions such as :raw-html:`
` - translation, rotation, :raw-html:`
` - resizing, skeletonization, :raw-html:`
` - displaying Matplotlib :raw-html:`
` - images, sorting contours, :raw-html:`
` - detecting edges, :raw-html:`
` - and much more easier - - - * - imageio - - - - METcalcpy, :raw-html:`
` - METplotpy - - https://pypi.org/project/imageio/ - - provides an easy :raw-html:`
` - interface to read :raw-html:`
` - and write a wide :raw-html:`
` - range of image data, :raw-html:`
` - including animated :raw-html:`
` - images, volumetric data, :raw-html:`
` - and scientific formats - - - * - lxml - - >=4.9.1 - - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://pypi.org/project/lxml/ - - a Pythonic binding for :raw-html:`
` - the C libraries :raw-html:`
` - libxml2 and libxslt - - - * - matplotlib - - >=3.6.3 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://matplotlib.org/stable/users/installing/index.html - - a comprehensive library :raw-html:`
` - for creating static, :raw-html:`
` - animated, and :raw-html:`
` - interactive visualizations - - `UserScript: - Make OMI plot from - calculated MJO indices with ERA obs only - (matplotlib) - <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_OMI.html>`__ :raw-html:`
` - `TCGen: - Genesis Density Function (GDF) - and Track Density Function (TDF) - (matplotlib) - <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ :raw-html:`
` - `UserScript: - Make a Phase Diagram plot - from input RMM or OMI - (matplotlib) - <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`_ :raw-html:`
` - `UserScript: - Make OMI plot from - calculated MJO indices with ERA obs and GFS fcst - (matplotlib) - <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ :raw-html:`
` - `UserScript: - Make RMM plots from - calculated MJO indices - (matplotlib) - <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ :raw-html:`
` - `CyclonePlotter: - Extra-TC Tracker and - Plotting Capabilities - (matplotlib) - <../generated/model_applications/tc_and_extra_tc/CyclonePlotter_fcstGFS_obsGFS_UserScript_ExtraTC.html>`_ :raw-html:`
` - * - metcalcpy - - - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://github.com/dtcenter/METcalcpy/releases - - a Python version of the :raw-html:`
` - statistics calculation :raw-html:`
` - functionality of :raw-html:`
` - METviewer, METexpress, :raw-html:`
` - plotting packages in :raw-html:`
` - METplotpy and is a :raw-html:`
` - stand-alone package for :raw-html:`
` - any other application - - `UserScript: - Make a Hovmoeller plot - (metcalcpy) - <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ :raw-html:`
` - `UserScript: - Compute Cross Spectra and Make a Plot - (metcalcpy) - <../generated/model_applications/s2s/UserScript_fcstS2S_obsERAI_CrossSpectra.html>`__ :raw-html:`
` - `Grid-Stat: - Verification of TC forecasts - against merged TDR data - (metcalcpy) - <../generated/model_applications/tc_and_extra_tc/GridStat_fcstHAFS_obsTDR_NetCDF.html>`_ :raw-html:`
` - `UserScript: - Calculate the Difficulty Index - (metcalcpy) - <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ :raw-html:`
` - `UserScript: - Make zonal and meridonial means - (metcalcpy) - <../generated/model_applications/s2s/UserScript_obsERA_obsOnly_Stratosphere.html>`_ :raw-html:`
` - * - metplotpy - - - - METplus wrappers - - https://github.com/dtcenter/METplotpy/releases - - contains packages for :raw-html:`
` - plotting in METplus as :raw-html:`
` - stand-alone, or part of :raw-html:`
` - METplus use case, :raw-html:`
` - METplus wrappers, :raw-html:`
` - METexpress, :raw-html:`
` - or METviewer - - `UserScript: - Make a Hovmoeller plot - (metplotpy) - <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_Hovmoeller.html>`_ :raw-html:`
` - `UserScript: - Compute Cross Spectra and Make a Plot - (metplotpy) - <../generated/model_applications/s2s/UserScript_obsPrecip_obsOnly_CrossSpectraPlot.html>`__ :raw-html:`
` - `UserScript: - Calculate the Difficulty Index - (metplotpy) - <../generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html>`_ :raw-html:`
` - `TCGen: - Genesis Density Function (GDF) - and Track Density Function (TDF) - (metplotpy) - <../generated/model_applications/s2s/TCGen_fcstGFSO_obsBDECKS_GDF_TDF.html>`_ - * - metpy - - >=1.4.0 - - METplus wrappers - - https://www.unidata.ucar.edu/software/metpy/ - - a collection of tools :raw-html:`
` - in Python for reading, :raw-html:`
` - visualizing, and :raw-html:`
` - performing calculations :raw-html:`
` - with weather data - - `Multi_Tool: - Feature Relative by Lead using - Multiple User-Defined Fields - (metpy) - <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ - * - nc-time-axis - - 1.4 - - METplotpy :raw-html:`
` - stratosphere_diagnostics - - https://github.com/SciTools/nc-time-axis - - extension to cftime :raw-html:`
` - \**REQUIRES Python 3.7 - - - * - netCDF4 - - >=1.6.2 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://unidata.github.io/netcdf4-python/ - - a Python interface to :raw-html:`
` - the netCDF C library - - For using MET Python embedding functionality in use cases - * - numpy - - >=1.24.2 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://numpy.org/ - - NumPy offers :raw-html:`
` - comprehensive :raw-html:`
` - mathematical functions, :raw-html:`
` - random number generators, :raw-html:`
` - linear algebra routines, :raw-html:`
` - Fourier transforms, and more. - - For using MET Python embedding functionality in use cases - * - pandas - - >=1.5.2 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://pypi.org/project/pandas - - a fast, powerful, :raw-html:`
` - flexible and easy to use :raw-html:`
` - open source data analysis :raw-html:`
` - and manipulation tool, :raw-html:`
` - built on top of the :raw-html:`
` - Python programming :raw-html:`
` - language - - For using MET Python embedding functionality in use cases - * - pint - - >=0.20.1 - - METcalcpy - - https://github.com/hgrecco/pint - - Python package to define, :raw-html:`
` - operate and manipulate :raw-html:`
` - physical quantities - - - * - plotly - - >=5.13.0 - - METcalcpy, :raw-html:`
` - METplotpy - - https://github.com/plotly/plotly.py - - makes interactive, :raw-html:`
` - publication-quality graphs - - - * - pygrib - - - - METplus wrappers - - https://github.com/jswhit/pygrib - - for reading/writing :raw-html:`
` - GRIB files - - `Multi_Tool: - Feature Relative by Lead - using Multiple User-Defined Fields - (pygrib) - <../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_ :raw-html:`
` - `GridStat: - Cloud Fractions Using GFS - and ERA5 Data - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstGFS_obsERA5_lowAndTotalCloudFrac.html>`_ :raw-html:`
` - `GridStat: - Cloud Height with Neighborhood - and Probabilities - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstMPAS_obsERA5_cloudBaseHgt.html>`_ :raw-html:`
` - `GridStat: - Cloud Pressure and - Temperature Heights - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstGFS_obsSATCORPS_cloudTopPressAndTemp.html>`_ :raw-html:`
` - `GridStat: - Cloud Fractions Using GFS - and MERRA2 Data - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstGFS_obsMERRA2_lowAndTotalCloudFrac.html>`_ :raw-html:`
` - `GridStat: - Cloud Fractions Using MPAS - and SatCORPS Data - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstMPAS_obsSATCORPS_lowAndTotalCloudFrac.html>`_ :raw-html:`
` - `GridStat: - Cloud Fractions Using MPAS - and MERRA2 Data - (pygrib) - <../generated/model_applications/clouds/GridStat_fcstMPAS_obsMERRA2_lowAndTotalCloudFrac.html>`_ - * - pylab - - - - METplus wrappers - - https://pypi.org/project/matplotlib/ - - a convenience module :raw-html:`
` - that bulk imports :raw-html:`
` - matplotlib.pyplot (for :raw-html:`
` - plotting) and NumPy (for :raw-html:`
` - Mathematics and working :raw-html:`
` - with arrays) in a :raw-html:`
` - single name space - - `WeatherRegime Calculation: - RegridDataPlane, PcpCombine, - and WeatherRegime python code - (pylab) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` - `WeatherRegime Calculation: - GFS and ERA RegridDataPlane, - PcpCombine, and WeatherRegime - python code - (pylab) - <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - * - pymysql - - >=1.0.2 - - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://pypi.org/project/psutil/ - - a pure-Python MySQL :raw-html:`
` - client library, :raw-html:`
` - based on PEP 249 - - - * - pyproj - - >=2.3.1 - - METplus wrappers - - https://github.com/pyproj4/pyproj/archive/v2.3.1rel.tar.gz - - Python interface to PROJ :raw-html:`
` - (cartographic projections and :raw-html:`
` - coordinate transformations library) - - `GridStat: - Python Embedding to read - and process ice cover - (pyproj) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ - * - pyresample - - - - METplus wrappers - - https://github.com/pytroll/pyresample - - for resampling geospatial :raw-html:`
` - image data - - `GridStat: - Python Embedding to read and - process SST - (pyresample) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ :raw-html:`
` - `GridStat: - Python Embedding to read and - process ice cover - (pyresample) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ :raw-html:`
` - `GridStat: - Python Embedding for sea surface salinity - using level 3, 1 day composite obs - (pyresample) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ :raw-html:`
` - `GridStat: - Python Embedding for sea surface salinity - using level 3, 8 day mean obs - (pyresample) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ - * - pytest - - >=7.2.1 - - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://github.com/pytest-dev/pytest/archive/5.2.1.tar.gz - - a mature full-featured :raw-html:`
` - Python testing tool that :raw-html:`
` - helps you write better :raw-html:`
` - programs - - - * - python-kaleido - - >=0.2.1 - - METcalcpy, :raw-html:`
` - METplotpy - - https://pypi.org/project/kaleido/ - - provides a low-level :raw-html:`
` - Python API that is :raw-html:`
` - designed to be used by :raw-html:`
` - high-level plotting :raw-html:`
` - libraries like Plotly - - - * - pyyaml - - >=6.0 - - METcalcpy, :raw-html:`
` - METplotpy, :raw-html:`
` - METdataio - - https://github.com/yaml/pyyaml - - a full-featured YAML :raw-html:`
` - framework for the Python :raw-html:`
` - programming language - - - * - scikit-image - - >=0.19.3 - - METcalcpy, :raw-html:`
` - METplotpy - - https://scikit-image.org - - a collection of :raw-html:`
` - algorithms for image :raw-html:`
` - processing - - - * - scikit-learn - - >=1.2.2 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://github.com/scikit-learn/scikit-learn/releases - - Open Source library for :raw-html:`
` - Machine Learning in Python - - `GridStat: - Python Embedding to read and process SST - (scikit-learn) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.html>`_ :raw-html:`
` - `GridStat: - Python Embedding to read and process ice cover - (scikit-learn) <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsOSTIA_iceCover.html>`_ :raw-html:`
` - `GridStat: - Python Embedding for sea surface salinity using level 3, - 1 day composite obs - (scikit-learn) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.html>`_ :raw-html:`
` - `GridStat: - Python Embedding for sea surface salinity using level 3, - 8 day mean obs - (scikit-learn) - <../generated/model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.html>`_ - * - scipy - - >=1.9.3 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://www.scipy.org/ - - wraps highly-optimized :raw-html:`
` - implementations written :raw-html:`
` - in low-level languages :raw-html:`
` - like Fortran, C, and C++ - - `Blocking Calculation: - ERA RegridDataPlane, - PcpCombine, and - Blocking python code - (scipy) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_Blocking.html>`_ :raw-html:`
` - `WeatherRegime Calculation: - RegridDataPlane, PcpCombine, and WeatherRegime python code - (scipy) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` - `UserScript: - Make OMI plot from calculated MJO indices with ERA obs only - (obs only) (scipy) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_OMI.html>`__ :raw-html:`
` - `WeatherRegime Calculation: - GFS and ERA RegridDataPlane, - PcpCombine, and - WeatherRegime python code - (scipy) - <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ :raw-html:`
` - `Blocking Calculation: - GFS and ERA RegridDataPlane, - PcpCombine, and - Blocking python code - (scipy) - <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_Blocking.html>`_ :raw-html:`
` - `UserScript: - Make a Phase Diagram plot from input RMM or OMI - (scipy) - <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_PhaseDiagram.html>`__ :raw-html:`
` - `UserScript: - Make OMI plot from calculated MJO indices with ERA obs and GFS fcst - (scipy) - <../generated/model_applications/s2s_mjo/UserScript_fcstGFS_obsERA_OMI.html>`__ :raw-html:`
` - `UserScript: - Make RMM plots from calculated MJO indices - (scipy) - <../generated/model_applications/s2s_mjo/UserScript_obsERA_obsOnly_RMM.html>`__ - * - sklearn - - - - METplus wrappers - - https://www.kite.com/python/docs/sklearn - - Simple and efficient :raw-html:`
` - tools for predictive :raw-html:`
` - data analysis - - `WeatherRegime Calculation: - RegridDataPlane, PcpCombine, and WeatherRegime python code - (sklearn) - <../generated/model_applications/s2s_mid_lat/UserScript_obsERA_obsOnly_WeatherRegime.html>`__ :raw-html:`
` - `WeatherRegime Calculation: - GFS and ERA RegridDataPlane, PcpCombine, and WeatherRegime python code - (sklearn) - <../generated/model_applications/s2s_mid_lat/UserScript_fcstGFS_obsERA_WeatherRegime.html>`__ - * - xarray - - >=2023.1.0 - - METplus wrappers, :raw-html:`
` - METcalcpy, :raw-html:`
` - METplotpy - - https://xarray.pydata.org/en/v0.17.0/ - - makes working with :raw-html:`
` - labelled :raw-html:`
` - multi-dimensional arrays :raw-html:`
` - simple, efficient, :raw-html:`
` - and fun - - For using MET Python embedding functionality in use cases - * - xesmf - - - - METplus wrappers - - NOTE: The xesmf package :raw-html:`
` - will not be installed :raw-html:`
` - on WCOSS2 and there is :raw-html:`
` - an open GitHub issue to :raw-html:`
` - replace the package in :raw-html:`
` - the use case that uses it: :raw-html:`
` - https://github.com/dtcenter/METplus/issues/1314 - - for regridding - - `PlotDataPlane: - Python Embedding of - tripolar coordinate file - (xesmf) - <../generated/model_applications/marine_and_cryosphere/PlotDataPlane_obsHYCOM_coordTripolar.html>`_ - * - yaml - - - - METcalcpy, :raw-html:`
` - METplotpy - - https://pypi.org/project/PyYAML/ - - to load, read, and write :raw-html:`
` - YAML files with PyYAML - - - Future development plans ======================== diff --git a/docs/conf.py b/docs/conf.py index 35a1790c21..60621e634a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,6 +24,10 @@ project = 'METplus' +python_version = '3.10.4' + +MET_version = '12.0.0' + author = 'UCAR/NCAR, NOAA, CSU/CIRA, and CU/CIRES' # list of contributing authors currently involved with the project From 43b320c963a60e15528b11b255342f329960a7b7 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Fri, 23 Feb 2024 15:45:57 -0700 Subject: [PATCH 39/47] trying to fix met_version --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 60621e634a..1544e3b029 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,7 +26,7 @@ python_version = '3.10.4' -MET_version = '12.0.0' +met_version = '12.0.0' author = 'UCAR/NCAR, NOAA, CSU/CIRA, and CU/CIRES' From cdf3c0b7b6bd5fcd25165ff564191ba85264c40f Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 26 Feb 2024 09:30:03 -0700 Subject: [PATCH 40/47] Per #2463, adding necessary code for substitutions --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 1544e3b029..e84aea89c3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -227,4 +227,6 @@ .. |release_date| replace:: {release_date} .. |release_year| replace:: {release_year} .. |release_info| replace:: {release_info} +.. |python_version| replace: {python_version} +.. |met_version| replace:: {met_version} """ From fc8b1d00a12ea21840b2f22443f612da614db15e Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 26 Feb 2024 09:34:14 -0700 Subject: [PATCH 41/47] Per #2463, fixing syntax error --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index e84aea89c3..18b29cbf6c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -227,6 +227,6 @@ .. |release_date| replace:: {release_date} .. |release_year| replace:: {release_year} .. |release_info| replace:: {release_info} -.. |python_version| replace: {python_version} +.. |python_version| replace:: {python_version} .. |met_version| replace:: {met_version} """ From 2699e178c8c72580977c84348aed81bd9c382760 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 26 Feb 2024 10:15:07 -0700 Subject: [PATCH 42/47] adding period --- docs/Users_Guide/overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index fadc5a751a..044ef6c5b5 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -93,7 +93,7 @@ METplus functionality. METplus Components Python Requirements ====================================== -See :ref:`metplus_components_python_packages` +See :ref:`metplus_components_python_packages`. Future development plans From d1fffab9991897b3ce9ee5a8249cf5ba1a4719c2 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Mon, 26 Feb 2024 10:22:48 -0700 Subject: [PATCH 43/47] removing section 1.5 --- docs/Users_Guide/overview.rst | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 044ef6c5b5..44169e3778 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -88,13 +88,6 @@ METplus Wrappers configuration files. Some Python wrappers do not correspond to a particular MET tool, but wrap utilities to extend METplus functionality. -.. _python_requirements_table: - -METplus Components Python Requirements -====================================== - -See :ref:`metplus_components_python_packages`. - Future development plans ======================== From d0e635adb014e062f9bc7e6c5b44273a4b05d1d6 Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Mon, 26 Feb 2024 13:30:53 -0700 Subject: [PATCH 44/47] Per #2463, replace old label reference with new label reference and updated text to reflect the move to drop down menus --- docs/Contributors_Guide/add_use_case.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Contributors_Guide/add_use_case.rst b/docs/Contributors_Guide/add_use_case.rst index 2deea9dba5..2d2d3d20d0 100644 --- a/docs/Contributors_Guide/add_use_case.rst +++ b/docs/Contributors_Guide/add_use_case.rst @@ -216,11 +216,11 @@ use case OR category directory for a model_applications use case * Update the description of the input data in the Datasets section. * Update the list of External Dependencies (if applicable) to include any - required Python packages. Update the :ref:`python_requirements_table` - table. If the package is already listed in the spreadsheet, add - a link to the documentation page for this new use case, following the - format in the table. If the package is not already listed, update - the table to include the name of the required package, the version, + required Python packages. Update the :ref:`components_python_packages` + section. If the package is already listed, add a link to the documentation + page for this new use case in the dropdown menu for that package, following the + format in the dropdown menu. If the package is not already listed, update + the dropdown menus to include the name of the required package, the version, the METplus component (e.g. METplus wrappers, METcalcpy, METplotpy), the source, a brief description of the package, and a link to this new use case that uses this new Python package. From f29dd22bfcb949d47562b95b6f24dc711e6e1d37 Mon Sep 17 00:00:00 2001 From: George McCabe <23407799+georgemccabe@users.noreply.github.com> Date: Tue, 27 Feb 2024 11:52:05 -0700 Subject: [PATCH 45/47] read python version from file to replace in docs --- docs/conf.py | 4 ++-- metplus/__init__.py | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 18b29cbf6c..661d93e0bc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,13 +19,12 @@ print(sys.path) from metplus import __version__, __release_date__ +from metplus import __python_version__ as python_version # -- Project information ----------------------------------------------------- project = 'METplus' -python_version = '3.10.4' - met_version = '12.0.0' author = 'UCAR/NCAR, NOAA, CSU/CIRA, and CU/CIRES' @@ -221,6 +220,7 @@ # -- Intersphinx control --------------------------------------------------------------- intersphinx_mapping = {'numpy':("https://docs.scipy.org/doc/numpy/", None)} +# -- Replace values in docs ------------------------------------------------------------ rst_epilog = f""" .. |copyright| replace:: {copyright} .. |author_list| replace:: {author_list} diff --git a/metplus/__init__.py b/metplus/__init__.py index 2696e90ad4..4a525bb399 100644 --- a/metplus/__init__.py +++ b/metplus/__init__.py @@ -21,6 +21,7 @@ def get_metplus_info(info_rel_path): __version__ = get_metplus_version() __release_date__ = get_metplus_release_date() +__python__version = get_python_version() # import util and wrappers from .util import * From e244b7f27920500dd94b948a68cf99136c12b3a4 Mon Sep 17 00:00:00 2001 From: George McCabe <23407799+georgemccabe@users.noreply.github.com> Date: Tue, 27 Feb 2024 11:54:23 -0700 Subject: [PATCH 46/47] fixed typo in variable name --- metplus/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metplus/__init__.py b/metplus/__init__.py index 4a525bb399..02a6079cfc 100644 --- a/metplus/__init__.py +++ b/metplus/__init__.py @@ -21,7 +21,7 @@ def get_metplus_info(info_rel_path): __version__ = get_metplus_version() __release_date__ = get_metplus_release_date() -__python__version = get_python_version() +__python_version__ = get_python_version() # import util and wrappers from .util import * From dca153b7672c3a0f66d85e32fd7f50a7ced4ba54 Mon Sep 17 00:00:00 2001 From: Lisa Goodrich Date: Wed, 28 Feb 2024 13:34:56 -0700 Subject: [PATCH 47/47] adding python_version to the overview. --- docs/Users_Guide/overview.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/Users_Guide/overview.rst b/docs/Users_Guide/overview.rst index 44169e3778..8ebbccc09e 100644 --- a/docs/Users_Guide/overview.rst +++ b/docs/Users_Guide/overview.rst @@ -69,8 +69,9 @@ their verification environments. Wrappers can be run individually, or as a group of wrappers that represent a sequence of MET processes. New wrappers can readily be added to the METplus Wrappers package due to this modular design. Currently, METplus Wrappers can easily be applied -by any user on their own computer platform that supports Python 3.10. -We have deprecated support to Python 2.7. +by any user on their own computer platform that supports +Python |python_version|. + The METplus Wrappers code and documentation is maintained by the DTC in Boulder, Colorado. METplus Wrappers is freely available to the modeling,