doc updates for 17.1.1 release and python-awips shortdoc
This commit is contained in:
parent
4d13888f84
commit
43e9189339
5 changed files with 60 additions and 22 deletions
BIN
docs/images/cave_linux_menu.png
Normal file
BIN
docs/images/cave_linux_menu.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 74 KiB |
|
@ -25,20 +25,18 @@ Unidata supports two visualization frameworks for rendering data: [CAVE](install
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Download CAVE
|
## Install CAVE 17.1.1
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
| | |
|
| | |
|
||||||
|----------------|-----------------------:|
|
|----------------|-----------------------:|
|
||||||
| Linux x86_64 | [installCAVE.sh <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/software/awips2/installCAVE.sh) |
|
| Linux x86_64 | [installCAVE.sh <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/software/awips2/installCAVE.sh) |
|
||||||
| macOS | [awips2-cave-16.2.2.dmg <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips2-cave-16.2.2.dmg)|
|
| macOS | Download and install both<br>[awips2-cave-17.1.1.dmg <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips2-cave-17.1.1.dmg)<br>[awips-python-jep.pkg <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-python-jep.pkg)|
|
||||||
| 32-bit Windows | [awips-cave.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.msi) |
|
| 32-bit Windows | [awips-cave.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.msi) |
|
||||||
| 64-bit Windows | [awips-cave.amd64.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.amd64.msi) |
|
| 64-bit Windows | [awips-cave.amd64.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.amd64.msi) |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Download EDEX Data Server
|
## EDEX Data Server 17.1.1
|
||||||
|
|
||||||
| | |
|
| | |
|
||||||
|----------------|-----------------------:|
|
|----------------|-----------------------:|
|
||||||
|
|
|
@ -4,10 +4,12 @@
|
||||||
|
|
||||||
<img style="width:300px;float:right;" src="../../images/Unidata_AWIPS2_CAVE.png">
|
<img style="width:300px;float:right;" src="../../images/Unidata_AWIPS2_CAVE.png">
|
||||||
|
|
||||||
| | |
|
|
||||||
|
|
||||||
|
| | current release 17.1.1 |
|
||||||
|----------------|-----------------------:|
|
|----------------|-----------------------:|
|
||||||
| Linux x86_64 | [installCAVE.sh <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/software/awips2/installCAVE.sh) |
|
| Linux x86_64 | [installCAVE.sh <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/software/awips2/installCAVE.sh) |
|
||||||
| macOS | [awips2-cave-16.2.2.dmg <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips2-cave-16.2.2.dmg)|
|
| macOS | Download and install both<br>[awips2-cave-17.1.1.dmg <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips2-cave-17.1.1.dmg)<br>[awips-python-jep.pkg <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-python-jep.pkg)|
|
||||||
| 32-bit Windows | [awips-cave.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.msi) |
|
| 32-bit Windows | [awips-cave.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.msi) |
|
||||||
| 64-bit Windows | [awips-cave.amd64.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.amd64.msi) |
|
| 64-bit Windows | [awips-cave.amd64.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.amd64.msi) |
|
||||||
|
|
||||||
|
@ -19,19 +21,15 @@
|
||||||
|
|
||||||
For CentOS/Red Hat 6 and 7. Installs to **/awips2/cave** and writes files to **~/caveData**.
|
For CentOS/Red Hat 6 and 7. Installs to **/awips2/cave** and writes files to **~/caveData**.
|
||||||
|
|
||||||
Install as root:
|
Install as root (all package dependencies should be resolved by yum)
|
||||||
|
|
||||||
chmod 755 ./installCAVE.sh
|
chmod 755 ./installCAVE.sh
|
||||||
./installCAVE.sh
|
./installCAVE.sh
|
||||||
|
|
||||||
All package dependencies should be resolved by yum.
|
|
||||||
|
|
||||||
|
Run CAVE from the menu **Applications** > **Internet** > **AWIPS CAVE**, or from the command line as simply `cave`.
|
||||||
|
|
||||||
**Run CAVE from the command line**
|

|
||||||
|
|
||||||
cave
|
|
||||||
|
|
||||||
or find CAVE in the GNOME menu **Applications** > **Internet** > **AWIPS CAVE**
|
|
||||||
|
|
||||||
!!! note "System Requirements"
|
!!! note "System Requirements"
|
||||||
|
|
||||||
|
@ -45,21 +43,23 @@ or find CAVE in the GNOME menu **Applications** > **Internet** > **AWIPS C
|
||||||
|
|
||||||
## <i class="fa fa-apple"></i> macOS
|
## <i class="fa fa-apple"></i> macOS
|
||||||
|
|
||||||
* [awips2-cave-16.2.2.dmg <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips2-cave-16.2.2.dmg)
|
CAVE for macOS requires the **[awips-python-jep.pkg](http://www.unidata.ucar.edu/downloads/awips2/awips-python-jep.pkg)** package be installed in order for **derived parameters** to work.
|
||||||
|
|
||||||
|
* [awips2-cave-17.1.1.dmg <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips2-cave-17.1.1.dmg)
|
||||||
|
* [awips-python-jep.pkg <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-python-jep.pkg)
|
||||||
|
|
||||||
|
*awips-python-jep.pkg* is not a prerequisite, and CAVE will still run and display data without it, but to use any derived parameter functions such as wind barbs/arrows and grid parameters on various vertical coordinates, [jep](https://github.com/mrj0/jep/) must be installed in some way (it is assumed in `/Library/Python/2.7/site-packages/jep/`). You are free to install jep yourself but should know that simply to install via source code or pip requires the Oracle JDK and Xcode and its Command Line Tools. The **[awips-python-jep.pkg](http://www.unidata.ucar.edu/downloads/awips2/awips-python-jep.pkg)** package is provided as a workaround for this.
|
||||||
|
|
||||||
|
|
||||||
Writes config files to **~/Library/CAVE**
|
!!! info "CAVE for macOS writes and syncs files to ~/Library/caveData"
|
||||||
|
|
||||||
!!! warning "macOS 10.12 (Sierra) not fully supported, requires cave be run from the command line."
|
|
||||||
|
|
||||||
New to 10.12 is Gatekeeper Path Randomization, which prevents applications delivered outside of the Mac App Store from running by normal means (taskbar icon or finder).
|
|
||||||
|
|
||||||
Until the next release, CAVE on Sierra should be run from the terminal with the command `/Applications/CAVE/cave.app/Contents/MacOS/cave`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## <i class="fa fa-windows"></i> Windows
|
## <i class="fa fa-windows"></i> Windows
|
||||||
|
|
||||||
|
Windows clients are still based on the CAVE 16.2.2 code base and provided in lieu of no 17.1.1 client.
|
||||||
|
|
||||||
* [awips-cave.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.msi)
|
* [awips-cave.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.msi)
|
||||||
* [awips-cave.amd64.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.amd64.msi)
|
* [awips-cave.amd64.msi <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/downloads/awips2/awips-cave.amd64.msi)
|
||||||
|
|
||||||
|
@ -82,7 +82,7 @@ Unidata and XSEDE Jetstream have partnered to offer a EDEX data server in the cl
|
||||||
|
|
||||||
**Localization Preferences Error**
|
**Localization Preferences Error**
|
||||||
|
|
||||||
You can reset CAVE by removing the **~/caveData** directory (on macOS **~/Library/CAVE**) and then run `cave` again to connect to an EDEX server. Your local files have been removed, but if you are re-connecting to an EDEX server you have used before, the remote files will sync again to your local **~/caveData** (bundles, colormaps, etc.).
|
You can reset CAVE by removing the **~/caveData** directory (on macOS **~/Library/caveData**) and then run `cave` again to connect to an EDEX server. Your local files have been removed, but if you are re-connecting to an EDEX server you have used before, the remote files will sync again to your local **~/caveData** (bundles, colormaps, etc.).
|
||||||
|
|
||||||
**No Images Displayed**
|
**No Images Displayed**
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,41 @@
|
||||||
|
The [python-awips](https://python-awips.readthedocs.io/en/latest/) package provides a data access framework for requesting grid and geometry datasets from an EDEX server.
|
||||||
|
|
||||||
|
!!! info "For a more detailed look at the python-awips package, refer to the [full documentation site](https://python-awips.readthedocs.io) which includes a number of [plotting examples for different data types](https://python-awips.readthedocs.io/en/latest/examples/index.html)."
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
pip install python-awips
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
* Python 2.7+
|
||||||
|
* Numpy 1.7+
|
||||||
|
* Shapely 1.4+
|
||||||
|
* MetPy and enum34 to run Jupyter Notebook examples
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
The simplest example requesting the RAP40 surface temperature grid from a remote EDEX server, saved to 2-dimensional Numpy arrays named `data`, `lons`, and `lats`.
|
||||||
|
|
||||||
|
from awips.dataaccess import DataAccessLayer
|
||||||
|
DataAccessLayer.changeEDEXHost("edex-cloud.unidata.ucar.edu")
|
||||||
|
request = DataAccessLayer.newDataRequest()
|
||||||
|
dataTypes = DataAccessLayer.getSupportedDatatypes()
|
||||||
|
request.setDatatype("grid")
|
||||||
|
request.addLocationNames("RAP40")
|
||||||
|
request.setParameters("T")
|
||||||
|
request.setLevels("0.0SFC")
|
||||||
|
cycles = DataAccessLayer.getAvailableTimes(request, True)
|
||||||
|
times = DataAccessLayer.getAvailableTimes(request)
|
||||||
|
response = DataAccessLayer.getGridData(request, times[-1])
|
||||||
|
for grid in response:
|
||||||
|
data = grid.getRawData()
|
||||||
|
lons, lats = grid.getLatLonCoords()
|
||||||
|
|
||||||
|
|
|
@ -62,7 +62,6 @@ pages:
|
||||||
- NCEP/Hydro: cave/d2d-hydro.md
|
- NCEP/Hydro: cave/d2d-hydro.md
|
||||||
- Map Overlays: cave/d2d-map-resources.md
|
- Map Overlays: cave/d2d-map-resources.md
|
||||||
- Python:
|
- Python:
|
||||||
- Derived Parameters: python/derived-parameters.md
|
|
||||||
- Python AWIPS API: python/python-awips-data-access.md
|
- Python AWIPS API: python/python-awips-data-access.md
|
||||||
- Development:
|
- Development:
|
||||||
- AWIPS Development Environment (ADE): dev/awips-development-environment.md
|
- AWIPS Development Environment (ADE): dev/awips-development-environment.md
|
||||||
|
|
Loading…
Add table
Reference in a new issue