Home

Welcome to the AC_tools wiki!

Here we keep some more detailed explanations of AC_tools' functionality, examples and rules for content.

The module is currently being updated to use cartopy and have more routines to use the new NetCDF diagnostics from GEOS-Chem http://wiki.seas.harvard.edu/geos-chem/index.php/Guide_to_GEOS-Chem_History_diagnostics. Similarly vestigial python 2 back-compatibility and functions using basemap are being removed. Please feel free to comment, edit, contribute, or point out any issues.

Use

AC_Tools is currently only installable from source. To do this, you can install via pip directly from git::

$ pip install git+https://github.com/tsherwen/AC_tools.git

or either clone the source directory and manually install (see below). However, the former approach is recommended for reasons including that it will automatically download the dependencies and track their metadata.

$ git clone https://github.com/tsherwen/AC_tools.git
$ cd AC_tools
$ python setup.py install

Develop / contribute

To develop or contribute, you can install the package as above but in editable mode (--editable) as below.

$ git clone https://github.com/tsherwen/AC_tools.git
$ cd AC_tools
$ pip install --editable .

You can then create a local branch and make changes. Pull requests are welcome.

$ git checkout -B my_branch 

and pull any updates from github and then add them on to your local branch.

$ git checkout master
$ git submodule update --recursive
$ git rebase my_branch

Setup and requirements

AC_tools uses existing python packages, which are installed by default when using pip to install.

It is recommended to use AC_tools in a virtual environment (e.g. see this guide to setting one up). Existing scientific python distributions such as Anaconda and Enthought are available.

Older parts of the code use Benoit Bovy's PyGChem code to convert GEOSChem output files (ctm.bpch) to NetCDF. This code is available via GitHub (https://github.com/benbovy/PyGChem/) and easy to install (as described here). New parts of the code do not require this and will not download this package.