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

doc updates for 18.1.1-6

Browse source
This commit is contained in:
Michael James 2019-03-21 15:54:02 -06:00 • committed by mjames-upc
parent a7871880d6
commit 0a5ce242a5
5 changed files with 67 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/cave/localization-perspective.md
View file

@ -6,8 +6,8 @@ AWIPS uses a hierarchical system known as *Localization* to configure many aspec
!!! note "There are three *levels of localization*, starting with the default **BASE**" !!! note "There are three *levels of localization*, starting with the default **BASE**"
* **BASE** - default * **BASE** - default
* **Site** - 3-letter WFO ID (required) overrides base * **SITE** - 3-letter WFO ID (required) overrides base
* **User** - user-level localization overrides site and base * **USER** - user-level localization overrides site and base
--- ---

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

@ -11,8 +11,8 @@ Default projections and areas available in the menu
* **World Mercator** * **World Mercator**
* **World CED** * **World CED**
* **World Mollweide** * **World Mollweide**
* **Geostationary (GOES East Full Disk)** * **Geostationary (GOES East & West 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. * **Regional** Mercator projections for **Africa**, **Australia/NZ**, **South America**, **Europe**, **Alaska**, **Hawaii**, **Puerto Rico**, **Japan**, **Pacific Ocean**, and the north and south poles.
There is also a **WFO** submenu which contains a map scale for every NWS localization site. There is also a **WFO** submenu which contains a map scale for every NWS localization site.

8
docs/edex/settings.md
View file

@ -5,8 +5,6 @@
The directory `/awips2/edex/conf/resources` contains configuration text files for specific plugins, which allow for user-defined values which are read by AWIPS plugins on EDEX start: The directory `/awips2/edex/conf/resources` contains configuration text files for specific plugins, which allow for user-defined values which are read by AWIPS plugins on EDEX start:
com.raytheon.edex.plugin.gfe.properties com.raytheon.edex.plugin.gfe.properties
com.raytheon.edex.plugin.grib.properties
com.raytheon.edex.plugin.radar.properties
com.raytheon.edex.text.properties com.raytheon.edex.text.properties
com.raytheon.uf.edex.archive.cron.properties com.raytheon.uf.edex.archive.cron.properties
com.raytheon.uf.edex.database.properties com.raytheon.uf.edex.database.properties
@ -16,7 +14,9 @@ The directory `/awips2/edex/conf/resources` contains configuration text files fo
edex-ogc.properties edex-ogc.properties
edex-requestsrv.properties edex-requestsrv.properties
goesr.properties goesr.properties
grib.properties
purge.properties purge.properties
radar.properties
warning.properties warning.properties
Look at *purge.properties* for example: Look at *purge.properties* for example:
@ -39,9 +39,9 @@ Look at *purge.properties* for example:
# Number of days older than the earliest known data to delete. # Number of days older than the earliest known data to delete.
purge.orphan.buffer=7 purge.orphan.buffer=7
In *com.raytheon.edex.plugin.grib.properties*, *com.raytheon.edex.plugin.radar.properties*, and *com.raytheon.edex.plugin.radar.properties* you can adjust the number of decoder threads for each plugin. In *grib.properties*, *goesr.properties*, and *radar.properties* you can adjust the number of decoder threads for each plugin.
cat com.raytheon.edex.plugin.radar.properties cat radar.properties
# Number threads for radar products ingested from the SBN # Number threads for radar products ingested from the SBN
radar-decode.sbn.threads=5 radar-decode.sbn.threads=5

11
docs/index.md
View file

@ -1,5 +1,7 @@
# Unidata AWIPS User Manual # Unidata AWIPS User Manual
[https://www.unidata.ucar.edu/software/awips2](https://www.unidata.ucar.edu/software/awips2)
--- ---
[ldm]: https://www.unidata.ucar.edu/software/ldm/ [ldm]: https://www.unidata.ucar.edu/software/ldm/
@ -15,13 +17,14 @@
[spring]: http://www.springsource.org/ [spring]: http://www.springsource.org/
[hibernate]: http://www.hibernate.org/ [hibernate]: http://www.hibernate.org/
[qpid]: http://qpid.apache.org [qpid]: http://qpid.apache.org
[idd]: https://www.unidata.ucar.edu/projects/#idd
[Unidata AWIPS](https://www.unidata.ucar.edu/software/awips2/) is a modified and extended version of AWIPS (originally developed by NWS and Raytheon) for non-operational use in research and education by [UCAR member institutions](http://president.ucar.edu/governance/members/universities-representatives). AWIPS (the Advanced Weather Interactive Processing System) is a meteorological decoding, display, and analysis package originally developed by the National Weather Service and Raytheon. UCAR's Unidata Program Center develops and supports a modified non-operational version of AWIPS for use in research and education by [UCAR member institutions](http://president.ucar.edu/governance/members/universities-representatives), which is released as open source software, free to download and use by anyone.
AWIPS takes a unified approach to data ingest, and most data types follow a path through the system starting with an [LDM](#ldm) client requesting data from the [Unidata IDD](https://www.unidata.ucar.edu/projects/#idd). Various raw data and product files (grib, BUFR, text, gini, McIDAS, NetCDF, more) are decoded and stored as HDF5 and Postgres metadata by [EDEX](install/install-edex), which then serves these data and products to clients over http. AWIPS takes a unified approach to data ingest, most data ingested into the system comes through the [LDM](#ldm) client pulling data feeds from the [Unidata IDD](#idd). Various raw data and product files (netCDF, grib, BUFR, ASCII text, gini, AREA) are decoded and stored as HDF5 and Postgres metadata by [EDEX](install/install-edex), which serves products and data over http.
Unidata supports two visualization frameworks for rendering data: [CAVE](install/install-cave), and the Python Data Access Framework ([python-awips](http://python-awips.readthedocs.io)). Unidata supports two data visualization frameworks: [CAVE](install/install-cave) (an Eclipse-built Java application which runs on Linux, Mac, and Windows), and the [python-awips](http://python-awips.readthedocs.io).
![CAVE](https://www.unidata.ucar.edu/software/awips2/images/Unidata_AWIPS2_CAVE.png) ![CAVE](https://www.unidata.ucar.edu/software/awips2/images/Unidata_AWIPS2_CAVE.png)
@ -37,7 +40,7 @@ Unidata supports two visualization frameworks for rendering data: [CAVE](install
## License ## 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_18.1.1/rpms/legal/Master_Rights_File.pdf) licensing file. 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 licensing file.
--- ---

53
docs/install/start-edex.md
View file

@ -1,7 +1,13 @@
## EDEX Service Manager To start all EDEX services
There are five EDEX service installed into `/etc/init.d/`, four of which run on boot: edex start
To stop all EDEX services
edex stop
These command will start and stop five EDEX service files installed into `/etc/init.d/`, four of which are run on boot:
service postgres start service postgres start
service httpd-pypies start service httpd-pypies start
@ -14,6 +20,8 @@ The fifth, `edex_ldm`, does **not run at boot** to prevent filling up disk space
All of these services are started and stopped by a single program `edex`, All of these services are started and stopped by a single program `edex`,
---
### edex start ### edex start
edex start edex start
@ -27,6 +35,14 @@ All of these services are started and stopped by a single program `edex`,
Starting AWIPS LDM:The product-queue is OK. Starting AWIPS LDM:The product-queue is OK.
... ...
### edex start base
To start all EDEX services *except* the LDM:
edex start base
---
### edex stop ### edex stop
edex stop edex stop
@ -40,6 +56,8 @@ All of these services are started and stopped by a single program `edex`,
Stopping AWIPS LDM:Stopping the LDM server... Stopping AWIPS LDM:Stopping the LDM server...
... ...
---
### edex setup ### edex setup
edex setup edex setup
@ -55,6 +73,8 @@ This command configures and/or confirms that the EDEX hostname and IP address de
> If your EDEX server is running but you see the message "Connectivity Error: Unable to validate localization preferences" in CAVE, it may mean that the domain name defined in `/awips2/edex/bin/setup.env` can not be resolved from *outside* the server. Some machines have different **internally-resolved** and **externally-resolved** domain names (cloud-based especially). The name defined in `setup.env` must be **externally-resolvable**. > If your EDEX server is running but you see the message "Connectivity Error: Unable to validate localization preferences" in CAVE, it may mean that the domain name defined in `/awips2/edex/bin/setup.env` can not be resolved from *outside* the server. Some machines have different **internally-resolved** and **externally-resolved** domain names (cloud-based especially). The name defined in `setup.env` must be **externally-resolvable**.
---
### edex log ### edex log
edex log edex log
@ -76,6 +96,33 @@ More edex logs...
edex log satellite edex log satellite
edex log text edex log text
---
### edex qpid
Shows a list of the the Qpid message queue to monitor data ingest (messages in vs messages out, i.e. decoded):
[centos@js-156-89 ~]$ edex qpid
Queues
queue dur excl msg msgIn msgOut bytes bytesIn bytesOut cons bind
================================================================================================
external.dropbox Y Y 11 1.26m 1.26m 621 79.6m 79.6m 5 1
Ingest.Radar Y Y 4 589k 589k 184 27.1m 27.1m 5 1
Ingest.GribDecode Y Y 0 370k 370k 0 103m 103m 11 1
Ingest.GribSplit Y Y 2 361k 361k 201 31.9m 31.9m 5 1
Ingest.modelsounding Y Y 0 100k 100k 0 6.54m 6.54m 1 1
Ingest.Text Y Y 0 97.8k 97.8k 0 5.25m 5.25m 2 1
Ingest.GOESR Y Y 0 83.4k 83.4k 0 6.92m 6.92m 2 1
Ingest.obs Y Y 0 46.2k 46.2k 0 2.40m 2.40m 1 1
Grid.PostProcess Y Y 0 20.2k 20.2k 0 6.68m 6.68m 1 1
Ingest.sfcobs Y Y 0 10.5k 10.5k 0 577k 577k 1 1
Ingest.goessounding Y Y 0 6.68k 6.68k 0 427k 427k 1 1
Ingest.Glm Y Y 0 5.61k 5.61k 0 581k 581k 1 1
Ingest.aww Y Y 0 3.32k 3.32k 0 182k 182k 1 1
---
### edex users ### edex users
To see a list of clients connecting to your EDEX server, use the `edex users [YYYYMMDD]` command, where `YYYYMMDD` is the optional date string. To see a list of clients connecting to your EDEX server, use the `edex users [YYYYMMDD]` command, where `YYYYMMDD` is the optional date string.
@ -88,6 +135,8 @@ To see a list of clients connecting to your EDEX server, use the `edex users [YY
awips@0.0.0.0 awips@0.0.0.0
awips@sdsmt.edu awips@sdsmt.edu
---
### edex purge ### edex purge
To view any stuck purge jobs in PortgreSQL (a rare but serious problem if your disk fills up). The solution to this is to run `edex purge reset`. To view any stuck purge jobs in PortgreSQL (a rare but serious problem if your disk fills up). The solution to this is to run `edex purge reset`.