Skip to content

Commit

Permalink
feature 1067 develop install instruct (#1156)
Browse files Browse the repository at this point in the history
* Per #1067, modified installation instructions and system configuration to point to installation instructions for MET

* removed RTD python package requirements since they are already installed by RTD - fixes issue where bulleted lists bullets disappeared

Co-authored-by: Julie Prestopnik <jpresto@seneca.rap.ucar.edu>
Co-authored-by: George McCabe <23407799+georgemccabe@users.noreply.github.com>
  • Loading branch information
3 people authored Sep 16, 2021
1 parent 00f25e3 commit 2ed9414
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 39 deletions.
47 changes: 17 additions & 30 deletions docs/Users_Guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ The following software is required to run METplus Wrappers:

- Python 3.6.3 or above

- MET version 10.0.0 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>`_
section of the MET User's Guide.

**Wrapper Specific Requirements**

Expand All @@ -54,12 +56,12 @@ The following software is required to run METplus Wrappers:

- SeriesAnalysis wrapper

- convert (ImageMagick) utility
- convert (ImageMagick) utility -
if generating plots and/or animated images from the output

- PlotDataPlane wrapper

- convert (ImageMagick) utility
- convert (ImageMagick) utility -
if generating images from the Postscript output

Python Package Requirements
Expand Down Expand Up @@ -99,7 +101,7 @@ and the following Python packages installed:

- netCDF4 (1.5.4)

See the `Software Installation <https://met.readthedocs.io/en/latest/Users_Guide/installation.html#software-installation-getting-started>`_
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.

**Wrapper Specific Requirements**
Expand Down Expand Up @@ -129,17 +131,16 @@ Getting the METplus Wrappers source code
========================================

The METplus Wrappers source code is available for download from the public
GitHub repository. The source code can be retrieved through a web
GitHub repository. The source code can be retrieved either through a web
browser or the command line.

Get the source code via Web Browser
-----------------------------------

- Create a directory where the METplus Wrappers will be installed

- Open a web browser and navigate to
https://github.com/dtcenter/METplus/releases/latest to view the
latest stable release.
- Open a web browser and go to the
`latest stable METplus release <https://github.com/dtcenter/METplus/releases/latest>`_.

.. image:: ../_static/metplus_repo_releases_page.png

Expand Down Expand Up @@ -167,23 +168,24 @@ HTTPS::
.. _obtain_sample_input_data:

Obtain sample input data
------------------------
========================

The use cases provided with the METplus release have sample input data
associated with them. This step is optional but is required to be able to run
the example use cases, which illustrate how the wrappers work.

- Create a directory to put the sample input data. This will be the directory
to set for the value of INPUT_BASE in the METplus Configuration.
- Create a directory to put the sample input data. This will be the directory
to set for the value of INPUT_BASE in the METplus Configuration.

- Navigate to the sample input data web URL: https://dtcenter.ucar.edu/dfiles/code/METplus/METplus_Data
- Go to the web page with the
`sample input data <https://dtcenter.ucar.edu/dfiles/code/METplus/METplus_Data>`_.

- Click on the vX.Y version directory that corresponds to the release to
install, i.e. v4.0 directory for the v4.0.0 release.

- Click on the sample data tgz file for the desired use case category or
categories run and when prompted, save the file to the directory created
above.
- Click on the sample data tgz file for the desired use case category or
categories run and when prompted, save the file to the directory created
above.

.. note::
Files with the version number in the name,
Expand Down Expand Up @@ -248,21 +250,6 @@ The **produtil/** directory contains part of the external utility produtil.
The **ush/** directory contains the run_metplus.py script that is
executed to run use cases.

Build_components and using manage_externals
===========================================

Running build_components/build_MET.sh will

- clone METplotpy, METcalcpy and METviewer from github using the manage_externals scripts
- grab the current MET compile script and all of the necessary external libraries
- download the most recent version of MET from github
- https://github.com/dtcenter/MET/releases/download/v10.0.0/met-10.0.0.20210510.tar.gz
- build the external libraries
- attempt to build MET

Building MET requires fine tuning on just about all systems.
However, using manage_externals should at least get most of the way through
the process and allow MET to be built with just a few manual changes.

External Components
===================
Expand Down
5 changes: 5 additions & 0 deletions docs/Users_Guide/systemconfiguration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,11 @@ Based on the directory listing output above, the following should be set::

MET_INSTALL_DIR = /usr/local/met

For information on installing MET please see the
`Software Installation/Getting Started <https://met.readthedocs.io/en/latest/Users_Guide/installation.html>`_
section of the MET User's Guide.


.. _sys_conf_input_base:

INPUT_BASE
Expand Down
9 changes: 0 additions & 9 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1 @@
sphinx==2.4.4
sphinx-gallery==0.7.0
sphinx-rtd-theme==0.4.3
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-bibtex
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==1.0.3
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.4

0 comments on commit 2ed9414

Please sign in to comment.