https://github.com/cemac/unrespforecastingsystem

Repository for the UNRESP Forecasting System

https://github.com/cemac/unrespforecastingsystem

Keywords

Repository

Repository for the UNRESP Forecasting System

https://github.com/cemac/UNRESPForecastingSystem/blob/master/

  
  



# UNRESP Forecasting System

[![GitHub release](https://img.shields.io/github/release/cemac/UNRESPForecastingSystem.svg)](https://github.com/cemac/UNRESPForecastingSystem/releases) [![GitHub top language](https://img.shields.io/github/languages/top/cemac/UNRESPForecastingSystem.svg)](https://github.com/cemac/UNRESPForecastingSystem) [![GitHub issues](https://img.shields.io/github/issues/cemac/UNRESPForecastingSystem.svg)](https://github.com/cemac/UNRESPForecastingSystem/issues) [![GitHub last commit](https://img.shields.io/github/last-commit/cemac/UNRESPForecastingSystem.svg)](https://github.com/cemac/UNRESPForecastingSystem/commits/master) [![GitHub All Releases](https://img.shields.io/github/downloads/cemac/UNRESPForecastingSystem/total.svg)](https://github.com/cemac/UNRESPForecastingSystem/releases) ![GitHub](https://img.shields.io/github/license/cemac/UNRESPForecastingSystem.svg) [![DOI](https://zenodo.org/badge/131827149.svg)](https://zenodo.org/badge/latestdoi/131827149)
[![HitCount](http://hits.dwyl.com/{cemac}/{UNRESPForecastingSystem}.svg)](http://hits.dwyl.com/{cemac}/{UNRESPForecastingSystem})




Repository for the [UNRESP](https://vumo.cloud/) Forecasting System:

An automated forecasting system has been created that uses the [CALPUFF](http://www.src.com/) dispersion model to predict S02 and S04 concentrations around the Masaya volcano. This is based on the current forecasting system implemented by IMO, but with modifications and improvements.

This work is displayed at: [homepages.see.leeds.ac.uk/~earunres](https://homepages.see.leeds.ac.uk/~earunres)
Documentation can be accessed at [https://cemac.github.io/UNRESPForecastingSystem/](https://cemac.github.io/UNRESPForecastingSystem/)

The repository hosts the scripts required to run the CALPUFF dispersion model to predict SO2 concentrations around the Masaya volcano forecasting for 48 hours using NAM data. The hourly output is plotted in individual png and googlemaps files (visualisation can be turned on or off).

## [DOCUMENTATION](https://github.com/cemac/UNRESPForecastingSystem/wiki) ##

**Full** Documentation can be found on this Repository's [wiki](https://github.com/cemac/UNRESPForecastingSystem/wiki)

Summary documention
- [Requirements](#Requirements)
- [Installation](#Installation)
- [Usage-Quick-Start](#Usage-Quick-Start)
- [Visualization](#Visualization)
- [Contributions](#Contributions)
- [Licence](#Licence)
- [Acknowledgements](#Acknowledgements)

- [Full-User-Guide](https://github.com/cemac/UNRESPForecastingSystem/wiki/User-Guide)
- [Developer-Guide](https://github.com/cemac/UNRESPForecastingSystem/wiki/Developer-Guide)

## Requirements ##

* UNIX operating system (tested: CentOS Ubuntu)
* [anaconda python](https://www.anaconda.com/distribution/#download-section)(recommended code works in python 2 and 3) (conda => 4.7.1 recommended)
  * requirements in `environment.yml` (python 3)
  * Analysis code requires additional packages covered in `unresp_analysis.yml` instead of environment.yml
* Intel compiler **OR** executables and library (only for similar architecture as built)

Non anaconda installations require a separate build of ecCodes python API:
* [ecCodes python API](https://confluence.ecmwf.int//display/ECC/Releases)
  * non environment set up can be followed using requirements.txt if desired

## Installation ##

Anaconda python (conda 4.7.1), unix systems (recommended), intel compilers or compiled executables

```
git clone https://github.com/cemac/UNRESPForecastingSystem.git
cd UNRESPForecastingSystem
./installcalpuff.sh
conda env create -f environment.yml
```

## Usage Quick-Start ##

Once installed to run full forecast and visualisation with default options:

```bash
cd $HOME/UNRESPForecastingSystem
./Run.sh -p
```

**NB** If no intel compilers the executables and libraries must be copied over to CALPUFF_EXE

For help run `.\Run.sh -h`

```
 Run.sh

 A CEMAC script to Run CALPUFF WITH NAM DATA input
 winds and produces plots of SO2 and SO4.

 Usage:
  .\Run.sh 

 No options runs a default production configuration:

 Today, Viz off. 48 hours.

 Options:
  -d  YYYYMMDD DEFAULT: 
  -v  name of viz defaults to UNRESPForecastingSystem/VIZ_SITE_CODE
  -n  forescast hours defaults to 48
  -x  resolution in m (100 < x < 1000)
 **
 The following switches can be used to overwrite
 Default behaviour.

 DEFAULT: output todays SO2 concrec files on topography
          background
 **
  -m turn OFF Forecasting model
  -p turn ON viz steps: default to SO2 on topography only
  -a turn ON all viz options except ffmpeg
  -b plot BOTH SO2 and SO4
  -t output BOTH satellite and topo backgrounds
  -g turn ON GOOGLE PLOTS
  -r SWITCH to satellite background
  -s SWITCH to SO4
  -y plot ONLY GOOGLE PLOTS
  -f turn ON ffmpeg mp4 production
  -h HELP: prints this message!

 ** TROUBLESHOOTING
 * Missing .so file --> most like intel library
   Try loading system intel e.g. module load intel or set LD_LIBRARY_PATH
 * Missing python modules --> mostly likely conda environment failure
   try `source activate unresp`
   or `conda activate unresp`
   or `load your system python libraries`
 ^^^ these fixes can be added to .env file for bespoke Setup
```

## Visualization

The output can be viewed by running:

```bash
cd $HOME/UNRESPForecastingSystem/VIZ_SITE_CODE/public_html
python -m http.server
```
And opening http://0.0.0.0:8000/ in any browser

All the code can be transported to desired location e.g. Apache server and the
forecasting scripts ran with a `-n` option to move to that location.

Currently 2 versions of the web vizulisation tool exist:

1. Full: all output generated, SO2, SO4, googlemaps, satellite and topography plots
2. Light: SO2 and SO4, only on topography plots (if running daily and want reduced output)

to use full:

```bash
cd $HOME/UNRESPForecastingSystem/VIZ_SITE_CODE/public_html/_includes/
ln -sf navbar_full.html navbar.html
ln -sf navbar_sensors_full.html navbar_sensors.html
```

to use light:

```bash
cd $HOME/UNRESPForecastingSystem/VIZ_SITE_CODE/public_html/_includes/
ln -sf navbar_light.html navbar.html
ln -sf navbar_sensors_light.html navbar_sensors.html
```



## Contributions ##

*coming soon: issues/suggestions - documentation improvements - code improvements/developments welcome*


## Licence ##

*This code is Open Source EXCEPT the CALPUFF code you will download*. The code changes to set up the model to run
CALPUFF for Masaya Region, forecast pipeline tools (preprocessing, postprocessing and visualisation), Python tools and static site image viewer (VIZ_SITE_CODE) are all covered under the MIT Licence.



## Acknowledgements ##

This repository has been developed in Collaboration with Sara Barsotti (Icelandic meteorological office),
 Evgenia Ilyinskaya (University of Leeds) as well as the code authors in the commit history. The Air quality sensor data stored in the visualization folders was produced in Collaboration with INITER.

Resources & References:

* Calpuff model code provided by Exponent
* *Scire, J.S., F.R. Robe, M.E. Fernau, and R.J. Yamartino. 2000a. A Users Guide for the CALMET Meteorological Model(Version5). Tech. Rep.,EarthTech,Inc., Concord, MA 332pp.(
  [CALMET_UsersGuide.pdf](http://www.src.com/calpuff/download/CALMET_UsersGuide.pdf)).*
* *Scire, J.S., D.G. Strimaitis, and R.J.Yamartino. 2000b. A Users Guide for the CALPUFF Dispersion Model(Version5),Tech.Rep.,EarthTech,Inc.,Concord,MA,521pp.(
  [CALPUFF_UsersGuide.pdf](http://www.src.com/calpuff/download/CALPUFF_UsersGuide.pdf)).*

Owner

GitHub Events