Skip to content

Commit

Permalink
per #1566, updated documentation to reflect new METplus requirement o…
Browse files Browse the repository at this point in the history
…f Python 3.8.6
  • Loading branch information
georgemccabe committed Jul 26, 2022
1 parent 20af6cb commit 059dbe7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 21 deletions.
20 changes: 10 additions & 10 deletions docs/Users_Guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Pre-built METplus images on DockerHub are also provided.
Programming/scripting languages
===============================

METplus Wrappers is written in Python 3.6.3. It is intended to be a tool
METplus Wrappers is written in Python. It is intended to be a tool
for the modeling community to use and adapt. As users make upgrades and
improvements to the tools, they are encouraged to offer those upgrades
to the broader community by offering feedback to the developers or
Expand All @@ -42,7 +42,7 @@ Software Requirements

The following software is required to run METplus Wrappers:

- Python 3.6.3 or above
- Python 3.8.6 or above

- MET version 10.0.0 or above -
For information on installing MET please see the `Software Installation/Getting Started <https://met.readthedocs.io/en/latest/Users_Guide/installation.html>`_
Expand Down Expand Up @@ -93,13 +93,13 @@ If running use cases that use Python embedding, the **MET** executables
must be installed with Python enabled
and the following Python packages installed:

- xarray (0.17.0)
- xarray (2022.3.0)

- numpy (1.19.2)
- numpy (1.22.4)

- pandas (1.0.5)
- pandas (1.4.2)

- netCDF4 (1.5.4)
- netCDF4 (1.5.8)

See `Appendix F Python Embedding <https://met.readthedocs.io/en/latest/Users_Guide/appendixF.html>`_
section in the MET User's Guide for more information.
Expand All @@ -115,13 +115,13 @@ to run.

- MakePlots wrapper

- cartopy (0.18.0)
- pandas (1.0.5)
- cartopy (0.20.3)
- pandas (1.4.3)

- CyclonePlotter wrapper

- cartopy (0.18.0)
- matplotlib (3.3.4)
- cartopy (0.20.3)
- matplotlib (3.5.2)

Cartopy, one of the dependencies of CyclonePlotter, attempts to download shapefiles from the internet to complete successfully. So if CyclonePlotter is run on a closed system (i.e. no internet), additional steps need to be taken. First, go to the Natural Earth Data webpage and download the small scale (1:110m) cultural and physical files that will have multiple extensions (e.g. .dbf, .shp, .shx). Untar these files in a noted location. Finally, create an environment variable in the user-specific system configuration file for CARTOPY_DIR, setting it to the location where the shapefiles are located.

Expand Down
12 changes: 1 addition & 11 deletions docs/Users_Guide/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,24 +112,14 @@ METplus Components Python Requirements
- Description
- Use Cases (only applicable for METplus wrappers component)(followed by
python package name)
* - Python 3.6.3+
* - Python 3.8.6+
-
- METplus wrappers, :raw-html:`<br />`
METcalcpy, :raw-html:`<br />`
METplotpy
-
-
-
* - Python 3.7
-
- METplus wrappers
-
-
- `Multi_Tool:
Feature Relative by Lead
using Multiple User-Defined Fields
(Python 3.7)
<../generated/model_applications/medium_range/TCStat_SeriesAnalysis_fcstGFS_obsGFS_FeatureRelative_SeriesByLead_PyEmbed_Multiple_Diagnostics.html>`_
* - cartopy
- >=0.18.0
- METplus wrappers, :raw-html:`<br />`
Expand Down

0 comments on commit 059dbe7

Please sign in to comment.