WRFotron#

GitHub release (latest by date) GitHub DOI

logo

Tools to automatise WRF-Chem runs with re-initialised meteorology.

WRFotron created by Christoph Knote (christoph.knote@med.uni-augsburg.de).

User guide created by Luke Conibear (l.a.conibear@leeds.ac.uk).

Helpful additions from Helen Burns, Carly Reddington, Ben Silver, Laura Kiely, Thomas Thorp, Ailish Graham, Doug Lowe, Scott Archer-Nicholls, Edward Butt, and Lauren Fleming.

Quick start#

WRFotron uses pre-built executables on ARC4 from CEMAC (for University of Leeds users). Everything required is loaded in config.bash, including Python, NCO, NCL, WPS, WRFMeteo, WRFChem, preprocessors, and ncview.

  1. Log into ARC4, clone the WRFotron repo, and edit the chainDir path within config.bash if it is not /nobackup/${USER}/WRFotron:

git clone https://github.com/wrfchem-leeds/WRFotron.git
  1. Load the availability of CEMAC modules. If have other modules loaded then unload them (module purge), and similarly deactivate conda (conda deactivate), as both of these can cause conflits:

. /nobackup/cemac/cemac.sh
  1. From within the WRFotron folder run master.bash:

. master.bash 2015 10 12 00 24 06

For users that require their own executables or that are from outside of the University of Leeds, you can manually compile them using the instructions here.

How to build the documentation#

  1. Clone the repository and create a branch to work on the docs:

git clone https://github.com/wrfchem-leeds/WRFotron.git
cd WRFotron
git checkout -b update-docs
  1. Edit the markdown files e.g., docs/faqs.md.

  2. Create a conda environment with jupyter-book installed e.g.:

conda env create -f environment.yml
conda activate wrfotron
  1. Build the docs locally using:

jupyter-book build docs
  1. View the docs locally by opening docs/_build/html/index.html in a browser.

  2. If you’re happy with the changes, open a pull request to merge your branch. Tag lukeconibear as a reviewer.