ACRG Repository

Shared Python code for the Atmospheric Chemistry Research Group (ACRG, University of Bristol). Dealing with trace gas observations, NAME model output and inversion code.

Getting Started

Prerequisites

• python 3
• git
• anaconda (recommended)
• fortran compiler (optional)

The ACRG code is written primarily using python 3. It is recommended to use Anaconda and an environment file is provided to setup a compatible python environment. The TDMCMC section of the repository contains FORTRAN code that must be compiled by the user to be used. Git is required both for obtaining the code and for stamping code outputs with version numbers.

Installing

1. Clone the repository

2. Setup paths:

   • copy acrg/config/templates/paths_default.yaml to acrg/config/paths.yaml
   • Overwrite the default folder paths in acrg/config/paths.yaml with your system specific values

3. Setup the python environment:

   • conda env create -f environment.yml
   • conda activate acrg
   • Note: creating the environment may take several minutes

4. The ACRG repository is ready to use! Start by running the tests (see below)

Running tests

To ensure the code has been setup properly, and to aid in development and maintenance, the repository comes with a suite of tests to be run. These should be run when you first install the code to ensure it is setup correctly, and frequently during code development work to prevent adding bugs to the code.

From the /tests/ folder run the terminal command 'pytest'. The complete test suite may take a few minutes to run. Run with 'pytest -v' for more information if any tests fail.

Credits

The code is developed and maintained by the ACRG Modelling team (http://www.bristol.ac.uk/chemistry/research/acrg/)