forked from dtcenter/METplus
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated readme to point to current documentation hosted on github.io
- Loading branch information
1 parent
45bd385
commit 6d783d9
Showing
1 changed file
with
4 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,13 @@ | ||
| METplus Repository README File {#METplus_README} | ||
| ============================== | ||
| Model Evaluation Tools Plus (METplus) Repository | ||
| ================================================ | ||
|
|
||
| Welcome to the documentation for the Model Evaluation Tools Plus (METplus). | ||
| Welcome to the METplus GitHub repository. | ||
|
|
||
| This is the METplus repository Top level README.md | ||
|
|
||
| Basic DOCUMENTATION - getting started | ||
| -------------------------------------- | ||
|
|
||
| ALL Documentation specific to this repository can be found in the doc/ | ||
| directory. | ||
|
|
||
| The ORIGINAL setup text documentation in a markdown file is found here. | ||
|
|
||
| * doc/README_install.md --- installation, configuration, running | ||
|
|
||
| * doc/README_terms_of_use.md --- legal Terms Of Use | ||
|
|
||
|
|
||
| ---- | ||
| Click here to view the documentation: https://ncar.github.io/METplus | ||
|
|
||
| METplus is a Python scripting infrastructure around the MET verification tools | ||
| (and eventually METViewer, a tool used for plotting MET output verification statistics). | ||
|
|
||
| This infrastructure utilizes the NCEP produtil package. | ||
| A Platform-independent weather and ocean forecasting utility package. | ||
| Developed at the National Oceanic and Atmospheric Administration (NOAA). | ||
|
|
||
| Website Documentation | ||
| ---------------------- | ||
| Users can generate an entire METplus documentation website, | ||
| if they have Doxygen version 1.8.9.1 or later installed. | ||
|
|
||
| cd METplus/sorc | ||
| make doc | ||
| In your browser, open the page METplus/doc/html/index.html | ||
|
|
||
|
|
||
|
|
||
| <!-- | ||
| INFORMATION BELOW THIS LINE can is intended and used when building the Website Documentation. | ||
| --> | ||
|
|
||
| Terms of Use | ||
| ------------ | ||
| @ref METplus_TermsOfUse | ||
|
|
||
| Install/Configure/Run Guide | ||
| ------------- | ||
| @ref METplus_install_guide | ||
|
|
||
| Produtil Guide | ||
| -------------- | ||
| @ref METplus_produtil | ||
|
|
||
| GitHub METplus - User Account Required | ||
| -------------------------------------- | ||
|
|
||
| <!-- to open link in a new tab, you have to use html, instead of the following markdown | ||
| [METplus GitHub Developer Page](https://www.github.com/NCAR/METplus) | ||
| --> | ||
|
|
||
| <a href="http://github.com/NCAR/METplus" target="_blank">METplus GitHub Developer Page</a> | ||
|
|
||
| GitHub wiki contents | ||
| --------------------------- | ||
| @ref wikicontents | ||
|
|