NOTE: This project has been archived and is now hosted at code.usgs.gov.
HVO-API is a companion application for the vsc-vdx project. The idea is to be able to extract JSON data from VDX databases (and a few other random sources) using easily constructable URLs. Initially written as a way to learn the datasets in use at HVO, it's been continually expanded as users have requested access to different data.
The app can be run as a desktop flask app via app.py, via a WSGI server with the run.wsgi script, or inside a docker container (see Dockerfile). If in a container, expected mounts are:
- config file (see sample in hvo_api/conf) at /app/hvo_api/conf/prod.py
- logfile to /app/hvo_api/error_logs (optional)
At a high level, you'd need the following to get any use out of this codebase:
- Python 3 and the packages listed in requirements.txt
- A webserver that can run python apps
- Some data to fetch. Note that VDX databases aren't explicitly required, but the code does expect the tables to have specific fields.
- Ash
- EDXRF
- Files (from a files directory defined in the config file)
- Flyspec Array Data
- GPS
- Gravity
- Hypocenters
- Lava level (Measurements taken with a Sick DT1000 sensor)
- Lava level (Old method)
- Logs (This is probably specific to VSC)
- NPSAdvisory
- RSAM
- RTNet
- SO2Emissions
- SO2HighRes
- Strain
- Tilt
- Tremor
- Triggers