xan/awips2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

mkdocs update for 17.1.1

Browse source
This commit is contained in:
Michael James 2017-06-13 12:50:18 -06:00 • committed by mjames-upc
parent 8948a7cc7b
commit 42d7a53005
18 changed files with 180 additions and 201 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/cave/bundles-and-procedures.md
View file

@ -1,4 +1,4 @@
## Bundles
## Save and Load Bundles
**File > Save Bundle**
@ -34,6 +34,6 @@ Load a map or product display from a path within the file directory of the works
Save a map or product display to a path within the file directory of the workstation.
## Procedures
## Save and Load Procedures

9
docs/cave/cave-localization.md
View file

@ -1,5 +1,5 @@
# Localization Preferences
## Localization Preferences
The default localization site for Unidata AWIPS is BOU (Boulder, Colorado, where UCAR is located). When you are prompted to connect to an EDEX server, you can change the WFO ID as well.
@ -12,10 +12,3 @@ Since release 16.1.4, CAVE users can switch the localization site to any valid N
Change the site (example shows TBW Tampa Bay) and click **Okay** or **Apply** and confirm the popup dialog, which informs you that you must *restart* CAVE for the changes to take effect.
![](../images/cave-localization-4.png)
# WFO Map Scales
AWIPS release 16.2.2 contains all WFO map scales selectable in the left-most dropdown (**CONUS** by default).
![](../images/map_scales.png)

4
docs/cave/d2d-edit-menus.md
View file

@ -1,7 +1,7 @@
Any of the data menus can be customized in the Localization Perspective.
# Changing the models displayed with D2D bundles
## Changing the models displayed with D2D bundles
1. In the Localization Perspective you can navigate to **D2D** > **Volume Browser** > **VbSources** and click on **volume.xml** to expand. Then right-click on **BASE** and select **Copy To...** **User** (awips).
@ -34,7 +34,7 @@ Your new localization file exists on the EDEX server (assuming username awips) a
and will exist on the local CAVE machine under `~/caveData/etc/user/awips/volumebrowser/VbSources/index.html`
# Removing menus from the menubar
## Removing menus from the menubar
This example covers how to remove a menu (in this case **MRMS**) from D2D:

1
docs/cave/d2d-gis-shapefiles.md
View file

@ -1,5 +1,4 @@
The Geographic Information System (GIS) application enables users to import geospatial data from varying GIS data sources for display in CAVE. CAVE currently only supports shape data in WGS84 unprojected latitude/longitude.
This section describes how to start the GIS application, configure the display attributes, and navigate through the various dialogs for importing map/map product shapefiles for display within CAVE. The following topics are discussed:

8
docs/cave/d2d-gridded-models.md
View file

@ -10,7 +10,7 @@ The Volume Browser window is divided into four areas:
Each area is then subdivided into menu components. The menu bar along the top of the Volume Browser window has dropdown lists that contain options for controlling all the various menu choices of the Volume Browser.
# Volume Browser Menu Bar
## Volume Browser Menu Bar
The dropdown menus in the Volume Browser menu bar contain options for controlling and manipulating the Volume Browser or the products chosen through the Volume Browser
@ -26,7 +26,7 @@ The dropdown menus in the Volume Browser menu bar contain options for controllin
* Select All
* Find (Ctrl+F)
# VB Tools
## VB Tools
>### Baselines
@ -55,7 +55,7 @@ Points may be created, deleted, hidden, and manipulated (location, name, font, a
not limited in terms of number, location, or designation. Points may also be assigned to different
groups to facilitate their use.
# Display Types
## Display Types
>### Plan View (default)
@ -82,7 +82,7 @@ Works in conjunction with the Interactive Points Tool to enable you to generate
Used in conjunction with the Interactive Points Tool to enable you to plot gridded data on a time versus data value graph for a specified point.
# Animation Types
## Animation Types
>### Time

14
docs/cave/d2d-perspective.md
View file

@ -17,42 +17,42 @@ Frame control, map projection, image properties, and a few featured applications
At bottom-right of the map window the the Resource Stack, which displays all loaded resources and map overlays, and allows for interaction and customization with the resource via a **right-click menu**.
>#### Left-Click Resource Name to Hide
> Left-Click Resource Name to Hide
A left click on any resource in the stack will hide the resource and turn the label gray. Clicking the name again makes the resource visible.
![image](../images/rASkR3Rp6y.gif)
>#### Left-Click Background to Hide Resource Types
> Left-Click Background to Hide Resource Types
A left click of the mouse anywhere on the map will hide the Resource Stack display names, which may help to declutter the view if a number of data types are loaded at once.
>#### Hold-Right-Click Background for Display Menu
> Hold-Right-Click Background for Display Menu
Holding down the right mouse button anywhere in the map view will open a right-click menu
![image](../images/rightclickmenu.gif)
>#### Show Map Legends
> Show Map Legends
From the above menu select **Show Map Legends** and watch the Resource Stack show only map resources which are loaded to the view.
![image](../images/maplayers.png)
>#### Toggle 2 or 4-Panel Layout
> Toggle 2 or 4-Panel Layout
Right-click hold in the view and select **Two Panel Layout** or **Four Panel Layout** to create duplicates of the current view (note that any data loaded to the *view* will be loaded to *both displays within the view*).
From this multi-pane display, hold-right-click again and you will see the **Single Panel Layout** option to switch back to a standard view (defaulting to the left of two, and top-left of four).
>#### Sample Loaded Resources
> Sample Loaded Resources
Most data types have a right-click menu option for reading out the pixel value, displayed as multi-line text for multiple resources.
![image](../images/ui4fNI3X0C.gif)
>#### Hold-Right-Click Resource Name for Menu
> Hold-Right-Click Resource Name for Menu
Drag the mouse over a loaded resource and **hold** the right mouse button until a menu appears (simply clicking the resource with the right mouse button will toggle its visibility).

20
docs/cave/d2d-radar-tools.md
View file

@ -1,19 +1,14 @@
These programs are accessible though the **Tools** dropdown menu, and in individual site radar menus.
# Estimated Actual Velocity (EAV)
## Estimated Actual Velocity (EAV)
A velocity (V) display from the radar shows only the radial component of the wind, so the indicated
speed depends on the direction of the wind and the azimuth (direction) from the radar. Consider, for example, a north wind. Straight north of the radar, the full speed of the wind will be seen on the V product. As one moves around to the east of the radar, the radial component gets smaller, eventually reaching zero straight east of the radar. If the wind direction is known, then the actual wind speed can be computed by dividing the observed radial speed by the cosine of the angle between the radar radial and the actual direction. The EAV tool allows you to provide that angle and use the sampling function of the display to show the actual wind speed.
![image](../images/qLuJnK2aVF.gif)
# 4-D Storm Investigator (FSI)
The [Four-dimensional Stormcell Investigator (FSI)](http://www.nws.noaa.gov/mdl/fsi/) was developed by the National Severe Storms Laboratory for its Warning Decision Support System Integrated Information. This technology allows users to create and manipulate dynamic cross-sections (both vertical and at constant altitude), such that one can “slice and dice” storms and view these data in three-dimensions and across time.
# V-R Shear
## V-R Shear
This tool is used in conjunction with Doppler velocity data to calculate the velocity difference (or "shear") of the data directly under the end points. As with the Baselines, this feature comes up editable and the end points can be dragged to specific gates of velocity data. When in place, the speed difference (kts), distance between end points (nautical miles), shear (s-1), and distance from radar (Nmi) are automatically plotted next to the end points and in the upper left corner of the Main Display Pane. A positive shear value indicates cyclonic shear, while a negative value indicates anticyclonic shear. If either end point is not directly over velocity data, the phrase "no data" is reported for the shear value. This tool is also useful in determining gate-to-gate shear. Simply place the two end points directly over adjacent gates of velocity data.
@ -24,7 +19,7 @@ four copies of the program running, and each behaves independently. This means t
get accurate readings in any one of the four panels — one VR - Shear panel is editable at a time. To activate, click the center mouse button on the VR - Shear legend in the desired panel and position the query line to the echoes of interest.
# Radar Display Controls
## Radar Display Controls
<span style="float:right;">
![image](../images/44N8kJq.png)
@ -35,7 +30,7 @@ Relative Motion (SRM) options. The Radar Display Controls dialog box options are
The Radar Display Controls dialog box is divided into six sections: STI, HI, TVS, DMD/MD/TVS, DMD, and SRM. Each section has the following options:
# STI (Storm Track Information)
## STI (Storm Track Information)
This section has options to adjust the appearance of the STI graphic product.
@ -43,7 +38,7 @@ This section has options to adjust the appearance of the STI graphic product.
* **Type of track to show**: This options menu allows you to choose the type of storm track that you want displayed.
# HI (Hail Index)
## HI (Hail Index)
This portion of the Radar Display Controls dialog box contains options that alter the appearance of the HI radar graphic product. You can set the low and high algorithm thresholds of the Probability of Hail (POH) and the Probability of Severe Hail (POSH). Storms that meet the low POH threshold are indicated by small open triangles, while small solid triangles mark those that meet the high POH threshold. Similarly, large open triangles or solid triangles are plotted for the POSH low and high thresholds, respectively.
@ -55,13 +50,14 @@ This portion of the Radar Display Controls dialog box contains options that alte
* **High severe hail probability**: The storms that meet or exceed the threshold are indicated by small solid triangles. The default setting is 50.
# TVS (Tornado Vortex Signature)
## TVS (Tornado Vortex Signature)
There is one option in this section of the Radar Display Controls dialog box.
* **Show elevated TVS**: This toggle button lets you control the appearance of the elevated TVS radar graphic product.
# DMD, MD, TVS
## DMD, MD, TVS
There is one option in this section of the Radar Display Controls dialog box.
Show extrapolated Features: With this option, you can choose whether to show the time-extrapolated
features using DMD, MD, or TVS.

34
docs/cave/d2d-tools.md
View file

@ -5,13 +5,13 @@ These programs are accessible though the **Tools** dropdown menu.
Many of the tools listed under the Tools menu can be placed into an editable state. Do not enable the "Hide Legends" feature if you want to place a tool in an editable state, because access to editability is by clicking the center mouse button over the Product Legend
# Az/Ran Overlay
## Az/Ran Overlay
This tool displays a movable azimuth/range radar map overlay. The overlay is in the "editable" state when displayed, and can be relocated by clicking the right mouse button.
![image](../images/xVAgVCCHwH.gif)
# Baselines
## Baselines
Selecting Baselines displays 10 lines, labeled A-A' to J-J', along which cross-sections can be constructed from within the Volume Browser. Baselines come up editable.
@ -19,19 +19,19 @@ Selecting Baselines displays 10 lines, labeled A-A' to J-J', along which cross-s
![image](../images/hK6RakT.png)
# Choose By ID
## Choose By ID
Choose By ID, which is a function of DMD (Digital Mesocyclone Display), is a method of selecting feature locations. The tool is used to monitor the same feature at a certain location. Without the Choose By ID tool, a monitored feature (over a period of time) could move away from its monitored location and another feature could move in its place. You can use Choose By ID to set points, baselines, and "Home" for conventional locations like METARs and RAOBs (Radiosonde Observations), but its primary use is for the WSR-88D-identified mesocyclone locations. You can also access the Choose By ID tool from the Tools menu on the Volume Browser.
![image](../images/E6cghWV.png)
# Distance Bearing
## Distance Bearing
Selecting this tool displays six editable lines, each of which shows the azimuth and range of the labeled end of the line relative to the unlabeled end of the line. You can make the lines editable by clicking the center mouse button over the legend at the lower right of the display. Once in edit mode, a line can be moved as a unit and/or either of its end points can be adjusted.
![image](../images/fgaCqrd.png)
# Distance Speed
## Distance Speed
This tool can be used to determine the speed and direction of a storm or any other meteorological feature of interest. Selecting Distance Speed displays a Centroid Marker to move to the location of the storm or feature of interest in any two or more frames of displayed imagery (e.g., a satellite or radar loop). The system then displays a storm track with the direction (degrees) and speed (knots) of movement. When you select the Distance Speed option, the Distance Speed dialog box opens.
@ -50,28 +50,28 @@ This tool can be used to determine the speed and direction of a storm or any oth
* **Speed**: A radio button that allows you to display speed with the Centroid Marker.
# Distance Scale
## Distance Scale
This tool can be used to determine the size of a storm or any other meteorological feature of interest.
![image](../images/iYYc68NN9w.gif)
# Feature Following Zoom
## Feature Following Zoom
When you zoom in over a small area to be able to view a feature in detail, animation will often cause the feature to move into and then out of the field of view. This tool allows you to follow a feature of interest even when zoomed in to a small area.
To use this feature, first, you need to identify the location and motion of the feature, using Distance Speed or the WarnGen tracker. Once satisfied that the tracking icon is following the feature of interest, load this tool, and the center of the zoom area will track with the Distance Speed icon. Toggling the overlay off will resume the standard zooming behavior, and toggling it back on will reinvoke the feature following zoom.
# Time of Arrival / Lead Time
## Time of Arrival / Lead Time
Selecting the Time Of Arrival / Lead Time option displays a tracking line from a feature's initial starting point in a past frame to its final position in the current frame. Once the final position is set, an Arrival Point is displayed. You can drag this point anywhere along the line to get the Time Of Arrival / Lead Time and Distance. You can also change the Mode from Point to Circular Front or Polyline anywhere along the line to better represent the feature(s).
# Home
## Home
Selecting the Home option displays a marker, which is an "X" with the word "Home" next to it.
Clicking on the Home Location Legend with the center mouse button makes the marker editable; drag the "X" or click with the right mouse button to change its location. When the Home Marker is displayed, use the Sample feature (clock and hold while moving the pointer around the screen) to display the range in miles and azimuth (in degrees) of the pointer location relative to the Home location.
# Points
## Points
The Points option initially displays a circular 10-point pattern, labeled A through J on the Map display. Points are used to generate model soundings, time-height cross-sections, time series, and variable vs. height plots using the Volume Browser. As with the Baselines, the locations of these Points can be edited in the following manner:
@ -127,7 +127,7 @@ or disassemble subgroups. The Points List dialog box also includes three columns
moved.
* **Hidden**: Checking the checkbox adjacent to the Point hides the Point on the map.
# Put home cursor
## Put home cursor
The Put home cursor tool provides an easy way to locate a METAR observation station, a city and
state, or a latitude/longitude coordinate. For Canada and Mexico, only the METAR observation stations and latitude/longitude coordinates are accessible. When you select Put home cursor from the Tools dropdown menu, the Home marker X is displayed and the Put Home Cursor dialog box opens.
@ -141,28 +141,26 @@ Station, City/State, or Lat/Lon radio button, an Entry Box is activated next to
* **Go**: This menu button initiates the search for the desired station, city/state, or latitude/longitude. The Home marker jumps to the newly specified location.
# Range Rings
## Range Rings
The Range Rings Tool displays adjustable range rings around locations of interest to your local office. When you select Range Rings from the Tools dropdown menu, the Range Rings legend appears in the Main Display Pane. The tool comes up editable, and the rangeRing dialog box opens. (Clicking B2 over the legend toggles tool editability and closes/opens the rangeRing dialog box.) Within this dialog box, you can toggle on/off any of the target locations using the square selectors. Adjust the size of the radii (in nautical miles) by typing a new value in the entry boxes associated with each location and pressing the Apply button. You can also add labels at the center of the range ring and/or at any of the radial distances using the Labels Options menu associated with each location. Using the Movable Rings, you can add a new location at a specific point by using the Interactive Points Tool, or by typing in latitude/longitude coordinates. There is no practical limit on the number of new locations you can add to the display. The list of locations is pre-set but can be customized at a field site
![image](../images/d0HFeY8.png)
# Sunset/Sunrise
## Sunset/Sunrise
By typing a date, as well as the latitude and longitude of a location into the Sunrise/Sunset Tool dialog box, you can obtain the time (for any time zone) of sunrise and sunset, as well as the total length of daylight for that date. Additional features include the ability to calculate the sunrise/sunset in a different hemisphere, and the azimuthal angles, relative to true north, of the sunrise and sunset.
![image](../images/jkzIvS0.png)
# Text Window
## Text Window
Selecting this option brings up a Text Display window that behaves in the same way, except for scripts, as a window on the Text Workstation.
# Units Calculator
## Units Calculator
This tool converts the units of the first column into differing units of the second column. The units are grouped into temperature, velocity, distance, time, and atmospheric pressure. First, simply type the number and select the units of the value you wish to convert in the firstcolumn entry box. Then in the second column, select the desired units to which you want the original value converted. The new value will appear in the second column entry box.
![image](../images/pdSH69h.png)
# Text Workstation
# Warngen
## Text Workstation

74
docs/cave/import-export.md Normal file
View file

@ -0,0 +1,74 @@
## Export Images
**File > Export > Image**
which captures a screenshot of the current view
![image](../images/UxmboZS.png)
---
## Export KML
**File > Export > KML**
The "Export" submenu also includes a "KML" option, which allows users to save D2D displays or
GFE grids in the KML (Keyhole Markup Language) file format. When zipped (compressed), the KML
file format forms a KMZ file, which can be used in applications such as Google Earth.
![image](../images/YRP9kOM.png)
The KML dialog box includes options to select frames to export. This includes exporting all frames,
the current/displayed frame, a range of frames, and, in GFE, the selected time range as highlighted in
the Grid Manager. Additional options are available for selection under the "Other Options" section:
* **Export Hidden**: When selected, all displayed and hidden products listed in the Product Legend section of the Main Display Pane will be exported.
* **Export Maps**: When selected, all enabled maps displayed within the Main Display Pane will be
exported.
* **Shade Earth**: When selected, a shaded background is applied to the exported product. If loaded in Google Earth, the earth will be overlaid with a black backdrop, and data will be displayed as it would in D2D with a black background.
* **Show Background Tiles**: When selected, data (such as plot data) will display on top of black
tiles when loaded in Google Earth.
---
## CAVE Import Formats
CAVE supported the following geo-referenced data files. CAVE can import the following through formats through the **CAVE** -> **Import** menu.
1. **GIS Data**
2. **BCD File**
3. **GeoTIFF**
4. **LPI File**
5. **SPI File**
6. **Displays**
![image](../images/image_14.png)
---
## CAVE Export Formats
CAVE can export to the following through the **CAVE** -> **Export** menu.
1. **KML**
2. **Editor Display**
3. **Perspective Display**
4. **Capture Current Frame**
5. **Capture All Frames**
6. **Print Screen**
![image](../images/image_15.png)

125
docs/cave/maps-views-projections.md
View file

@ -1,4 +1,5 @@
## Default Maps
## Default Map Scales
The first toolbar menu item is a dropdown menu for different geographic areas and map projections. The efault view is always **CONUS**, which is a North Polar Steregraphic projection centered on the Continental United States.
@ -10,13 +11,17 @@ Default projections and areas available in the menu
* **World Mercator**
* **World CED**
* **World Mollweide**
* **Geostationary (GOES East Full Disk)**
* and **Regional** Mercator projections for **Africa**, **Australia/NZ**, **South America**, **Europe**, **Alaska**, **Hawaii**, **Puerto Rico**, **Japan**, **Pacific Ocean**, and the north and south poles.
![image](../images/mapscales.jpg)
There is also a **WFO** submenu which contains a map scale for every NWS localization site.
![image](../images/map_scales.png)
---
## New Map / New View
## New Map Editor / View
**File > New Map**
@ -37,117 +42,3 @@ This can also be done by **right-click** on any tab and selecting **New Editor**
Create a new map projection.
![image](../images/VANzMW2.png)
---
## Saving / Loading Bundles
**File > Save Bundle**
Save a product display within the AWIPS system, synching the bundle between CAVE and the EDEX server.
![image](../images/xl53gG4.png)
**File > Load Bundle**
Load a previously-saved bundle from within the AWIPS system.
![image](../images/VWiGMHp.png)
**File > Delete Bundle**
Select and remove a saved bundle.
![image](../images/eRqHZpD.png)
**File > Load Bundle from Disk**
Load a previously-saved display from a path within the file directory of the workstation.
**File > Save Bundle to Disk**
Save a product display to a path within the file directory of the workstation.
**File > Load Map from Disk**
Load a map or product display from a path within the file directory of the workstation.
**File > Save Map to Disk**
Save a map or product display to a path within the file directory of the workstation.
---
## Screenshots
**File > Export > Image**
which captures a screenshot of the current view
![image](../images/UxmboZS.png)
---
## KML
**File > Export > KML**
The "Export" submenu also includes a "KML" option, which allows users to save D2D displays or
GFE grids in the KML (Keyhole Markup Language) file format. When zipped (compressed), the KML
file format forms a KMZ file, which can be used in applications such as Google Earth.
![image](../images/YRP9kOM.png)
The KML dialog box includes options to select frames to export. This includes exporting all frames,
the current/displayed frame, a range of frames, and, in GFE, the selected time range as highlighted in
the Grid Manager. Additional options are available for selection under the "Other Options" section:
* **Export Hidden**: When selected, all displayed and hidden products listed in the Product Legend section of the Main Display Pane will be exported.
* **Export Maps**: When selected, all enabled maps displayed within the Main Display Pane will be
exported.
* **Shade Earth**: When selected, a shaded background is applied to the exported product. If loaded in Google Earth, the earth will be overlaid with a black backdrop, and data will be displayed as it would in D2D with a black background.
* **Show Background Tiles**: When selected, data (such as plot data) will display on top of black
tiles when loaded in Google Earth.
---
## CAVE Import Formats
CAVE supported the following geo-referenced data files. CAVE can import the following through formats through the **CAVE** -> **Import** menu.
1. **GIS Data**
2. **BCD File**
3. **GeoTIFF**
4. **LPI File**
5. **SPI File**
6. **Displays**
![image](../images/image_14.png)
---
## CAVE Export Formats
CAVE can export to the following through the **CAVE** -> **Export** menu.
1. **KML**
2. **Editor Display**
3. **Perspective Display**
4. **Capture Current Frame**
5. **Capture All Frames**
6. **Print Screen**
![image](../images/image_15.png)

14
docs/devguide/data-distribution-files.md → docs/edex/data-distribution-files.md
View file

@ -1,4 +1,6 @@
EDEX alerts the appropriate decoding plug-ins of new data by use of XML files that describe data based on regular expressions. If the WMO header, or file name, matches a regular expression listed in a distribution XML, then EDEX will put a message into the QPID queue for the decoder which indicates that a piece of data is available. If a piece of data does not match any distribution XML, EDEX will:
* Create an entry in `/awips2/edex/logs/edex-ingest-unrecognized-files-yyyymmdd.log`
@ -67,7 +69,7 @@ The contents of the base version of the radar distribution file:
Looking at the base radar.xml distribution file in the previous example, there are two regular expressions. The first regular expression matches the standard WMO ID of radar products. Via the edexBridge the LDM will place a message in the external.dropbox QPID queue, indicating a radar product has arrived. EDEX will then take the message containing the radar WMO ID and compare it against the regular expressions in radar.xml. If a match is found, EDEX places a message in the QPID queue Ingest.radar. The radar decoder will then consume the message and process the radar data accordingly.
# Adding a REGEX to the Satellite Data Distribution File
## Adding a REGEX to the Satellite Data Distribution File
As a quick example, suppose we have a local data source for satellite imagery that does not have a WMO header; also suppose that the data source writes to files whose names start with **LOCAL.sat**.
@ -87,15 +89,15 @@ To add this locally produced satellite data file to the EDEX distribution; perfo
Raw files are written to **/data_store**, and a message is sent via QPID to the EDEX distribution service from the LDM. When a regular expression match is found in a data distribution file, the raw data file is placed in a queue for the matching plugin to decode and process. The distribution files are used to match file headers as well as filenames, which is how files dropped into EDEX’s manual endpoint (**/awips2/data_store/ingest**) are processed.
# Editing an EDEX Data Distribution File
## Editing an EDEX Data Distribution File
Because these files are in the **edex_static/** directory, they have to be manually edited using a text editor. You should not edit the base files; rather, you should copy the base version to your site and then edit the site version. The regular expressions in the distribution files need to correspond with the regular expressions in the LDM **_pqact.conf_**** **file.
If patterns exist in **_pqact.conf_** but are not in the distribution files, then raw data files will be written to **/data_store** but will not be ingested and processed by EDEX. Entries for these non-ingested files would be written to the unrecognized files log in **/awips/edex/logs**.
# EDEX Data Distribution File Examples
## Examples
## Surface Obs
### Surface Obs
**/awips2/edex/data/utility/edex_static/base/distribution/obs.xml** Processes any file header that starts with **SA** or **SP**, which should match any WMO header that contains METAR data (e.g.**SAUS**, **SPUS**, **SACN**, **SAMX**).
@ -103,7 +105,7 @@ If patterns exist in **_pqact.conf_** but are not in the distribution files, the
<regex>^S[AP].*</regex>
</requestPatterns>
## Text Data
### Text Data
**/awips2/edex/data/utility/edex_static/base/distribution/text.xml** Processes lots of WM patterns. The second pattern ^S[A-CEG-Z].* matches any header that starts with **S** except for **SD**or **SF**, so it also matches the **SA** and **SP** files that the **obs.xml** plugin matches. This means that METARs are processed by both plugins simultaneously.
@ -125,7 +127,7 @@ If patterns exist in **_pqact.conf_** but are not in the distribution files, the
<regex>^F[EHIJKLMQVWX].*</regex>
</requestPatterns>
## Grib Data
### Grib Data
**/awips2/edex/data/utility/edex_static/base/distribution/grib.xml** The grib/grid decoder distribution file matches all numerical grids distributed over the IDD NGRID feed by matching WMO header, and from CONDUIT by matching the *.grib* file extension.

19
docs/edex/data-purge.md
View file

@ -5,7 +5,7 @@ AWIPS uses a plugin-based purge strategy for HDF5 data, allowing the user to cha
Purging rules are defined in XML files in the Localization Store, accessible from the CAVE localization perspective. On EDEX, most are located in `/awips2/edex/data/utility/common_static/base/purge`, and follow the **base/site** localization pattern (e.g. site purge files are in `site/XXX/purge` rather than `base/purge`, where XXX is the site identifier.
# Time-base purge
## Time-base purge
If a plugin has no XML file, the default rule of 1 day (24 hours) is used, from `/awips2/edex/data/utility/common_static/base/purge/defaultPurgeRules.xml`
@ -18,19 +18,20 @@ If a plugin has no XML file, the default rule of 1 day (24 hours) is used, from
Time-based purging uses the *reference time* of the data, and dtermination of the reference time is decoder based.
> ### 30-day NEXRAD3 archive
>Modify `/awips2/edex/data/utility/common_static/base/purge/radarPurgeRules.xml` to increase the data retention period from 7 to 31 days:
>
## 30-day NEXRAD3 Example
Modify `/awips2/edex/data/utility/common_static/base/purge/radarPurgeRules.xml` to increase the data retention period from 7 to 31 days:
<purgeRuleSet>
<defaultRule>
<period>31-00:00:00</period>
</defaultRule>
</purgeRuleSet>
>
>**Note**: you do NOT have to restart EDEX when you change a purge rule!
**Note**: you do NOT have to restart EDEX when you change a purge rule!
# Frame-based purge
## Frame-based purge
Some plugins use frame-base purging, retaining and certain number of prpduct "versions".
@ -53,7 +54,7 @@ Some plugins use frame-base purging, retaining and certain number of prpduct "ve
> In the above example, notice a *default rule* (196) as well as specific sectors with their own rules.
# Logging
## Purge Logs
Data purge events are logged to the file `edex-ingest-purge-<yyyymmdd>.log`, where `<yyyymmdd>` is the date stamp.
@ -68,7 +69,7 @@ Data purge events are logged to the file `edex-ingest-purge-<yyyymmdd>.log`, whe
INFO 2012-03-27 00:31:23,155 [DefaultQuartzScheduler_Worker-3] PurgeLogger: EDEX - PURGE LOGS::---------END LOG PURGE-----------
# All Purge Rules
## All Purge Rules
To see all purge rule directories (base, site, region, configured):

10
docs/edex/ldm.md
View file

@ -1,5 +1,5 @@
# Default LDM Feeds for EDEX
## Default LDM Feeds for EDEX
from `/awips2/ldm/etc/ldmd.conf`
@ -16,7 +16,7 @@ from `/awips2/ldm/etc/ldmd.conf`
> Remember than LDM commands such as these require **TAB SEPARATION** between items.
# Optional LDM Feeds
## Optional LDM Feeds
FNMOC and CMC models
@ -32,13 +32,13 @@ FSL/GSD Experimental HRRR (Sub-hourly)
REQUEST FSL2 "^GRIB2.FSL.HRRR" hrrr.unidata.ucar.edu
# Restart the LDM
## Restart the LDM
sudo service edex_ldm restart
ldmadmin restart
# Monitor Incoming Data Feeds
## Monitor Incoming Data Feeds
To watch incoming data in real-time:
@ -52,7 +52,7 @@ To watch the same on a remote queue:
notifyme -vl - -h idd.unidata.ucar.edu -f NEXRAD3 -p DHR -o 360
# Logging
## LDM Logging
edex log ldm

10
docs/edex/new-grid.md
View file

@ -7,7 +7,7 @@ To add support for a new grid, two edits must be made:
* **Grid name**, **center**, **subcenter**, and **process ID** must be defined in a *model definition file*.
# Ingest an Unsupported Grid
## Ingest an Unsupported Grid
1. Download an example grib1 file and rename to a `*.grib` extension, then copy to the manual ingest point `/awips2/data_store/ingest/`
@ -34,7 +34,7 @@ To add support for a new grid, two edits must be made:
Though the grib file has been decoded, it has been given a generic name with its center, subcenter, and process IDs (7, 0, 89, respectively).
# Determine Grid Projection
## Determine Grid Projection
When the grid was ingested a record was added to the `grid_coverage` table with its navigation information:
@ -61,7 +61,7 @@ Compare with the projection info returned by wgrib on the original file:
Notice that our grib1 file is a **Lambert Conformal** projection. We will need these values for the next step. Note that **there is a tolerance of +/- 0.1 degrees** to keep in mind when defining your coverage area.
# Create Grid Projection File
## Create Grid Projection File
Grid projection files are stored in `/awips2/edex/data/utility/edex_static/base/grib/grids/` and there are four grid coverage types available:
@ -170,7 +170,7 @@ And edit the new `wrf.xml` to define the projection values (example provided):
> Notice `<name>201155</name>` defined from the number of grid points (201 x 155). This value will be matched against an entry in our models file (below) to set the name of the model (e.g. WRF).
# Create Model Definition
## Create Model Definition
Model definition XML files are found in **/awips2/edex/data/utility/edex_static/base/grid/models/**. Since our grib1 file has a center ID of 7 (NCEP) we will edit the **gribModels_NCEP-7.xml** file.
@ -202,7 +202,7 @@ Now copy the `wrf.grib` file *again* to **/awips2/data_store/ingest/**. If ever
After you have confirmed that the grid was ingested with the given name, you can [edit the D2D product menus to display the new grid](../cave/d2d-edit-menus.html).
# Troubleshooting Grib Ingest
## Troubleshooting Grib Ingest
If you ingest a piece of data and the parameter appears as unknown in the metadata database, ensure that the correct parameter tables are in place for the center/subcenter.

23
docs/index.md
View file

@ -25,6 +25,29 @@ Unidata supports two visualization frameworks for rendering data: [CAVE](install
---
## Download CAVE
---
| | |
|----------------|-----------------------:|
| 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)|
| 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) |
---
## Download EDEX Data Server
| | |
|----------------|-----------------------:|
| Linux x86_64 | [installEDEX.sh <i class="fa fa-download"></i>](http://www.unidata.ucar.edu/software/awips2/installEDEX.sh) |
[Read full EDEX install instructions...](install/install-edex.html)
---
## License
Unidata AWIPS source code and binaries (RPMs) are considered to be in the public domain, meaning there are no restrictions on any download, modification, or distribution in any form (original or modified). Unidata AWIPS contains no proprietery content and is therefore not subject to export controls as stated in the [Master Rights](https://github.com/Unidata/awips2/blob/unidata_16.2.2/rpms/legal/Master_Rights_File.pdf) licensing file.

0
docs/python/derived-parameters.md Normal file
View file

0
docs/python/python-awips-data-access.md Normal file
View file

12
mkdocs.yml
View file

@ -32,25 +32,23 @@ pages:
- CAVE User Manual:
- D2D Perspective: cave/d2d-perspective.md
- Maps, Views, Projections: cave/maps-views-projections.md
# - Bundles and Procedures: cave/bundles-and-procedures.md
- Bundles and Procedures: cave/bundles-and-procedures.md
- Import/Export: cave/import-export.md
- Localization Perspective: cave/localization-perspective.md
- NCP Perspective: cave/ncp-perspective.md
- NSHARP: cave/nsharp.md
- WarnGen: cave/warngen.md
- GIS and Shapefiles: cave/d2d-gis-shapefiles.md
- Volume Browser: cave/d2d-gridded-models.md
# - Derived Parameters: cave/d2d-gridded-models.md
# - GEMPAK Grid Display: cave/d2d-gridded-models.md
- Display Tools: cave/d2d-tools.md
- Radar Tools: cave/d2d-radar-tools.md
- Editing Menus: cave/d2d-edit-menus.md
- Change Localization: cave/cave-localization.md
- Keyboard Shortcuts: cave/cave-keyboard-shortcuts.md
- EDEX User Manual:
- EDEX Start and Stop: install/start-edex.md
- LDM Feeds: edex/ldm.md
- Data Distribution Files: edex/data-distribution-files.md
- Ingest a New Grid: edex/new-grid.md
- Data Distribution Files: devguide/data-distribution-files.md
- Purging and Retention: edex/data-purge.md
- Monitor Users: edex/edex-users.md
- Data Plugins: edex/data-plugins.md
@ -62,11 +60,15 @@ pages:
- Upper Air: cave/d2d-uair.md
- NCEP/Hydro: cave/d2d-hydro.md
- Map Overlays: cave/d2d-map-resources.md
- Python:
- Derived Parameters: python/derived-parameters.md
- Python AWIPS API: python/python-awips-data-access.md
- Appendix:
- AWIPS Grid Parameters: appendix/appendix-grid-parameters.md
- Acronyms and Abbreviations: appendix/appendix-acronyms.md
- COTS and FOSS: appendix/appendix-cots.md
- WSR-88D Product Table: appendix/appendix-wsr88d.md
- Keyboard Shortcuts: cave/cave-keyboard-shortcuts.md
extra_css:
- css/extra.css