Package: metoffice-afterburner
Afterburner PackageWhat is Afterburner?Afterburner is a Python package that provides functionality for analysing and
processing climate model data, in particular, though not exclusively, data
produced by the UK Met Office'sUnified Model.At present the Afterburner codebase is compatible with both Python 2.7 and
Python 3.6 or later. However, since official support for Python 2.7 has now
ceased the use of Python 3 is firmly recommended.LicenseAfterburner software is made available under a 3-Clause BSD license, as detailed
in the LICENSE.TXT file which can be found in the root directory of the Afterburner
distribution.DependenciesTheafterburnerpackage depends upon the following packages, each of which have
their own dependencies.scitools-iris(version 2.1 or later; version 2.4 recommended)pyparsingwindspharmsphinx(only required if you intend to build
and install the documentation set)nose(only required if you intend to run the unit tests)InstallationTheafterburnerpackage can be installed fromPyPIorconda-forge. Installing from conda-forge is the
recommended method.Installing from PyPIAlthough theafterburnerpackage can be installed from PyPI, installing certain
prerequisite packages (notablycartopy) can be challenging. Consequently, it is
recommended that you first install Iris into a suitable conda environment, and
then usepipto installafterburnerinto that environment, but skipping
installation of dependent packages (using the--no-depsoption).% conda activate <your-env>
% conda info -c conda-forge iris==2.4.0   # just to preview package dependencies
% conda install -c conda-forge iris==2.4.0
% conda install -c conda-forge windspharm
% pip install --no-deps metoffice-afterburnerNote: installing Iris should take care of installing thepyparsingpackage.Installing from conda-forge% conda activate <your-env>
% conda install -c conda-forge iris==2.4.0
% conda install -c conda-forge windspharm
% conda install -c conda-forge metoffice-afterburnerInstalling from a tarballYou may also install directly from the source distribution. After downloading the
package tarball from PyPI, unpack it, change to the source directory, then enter
the following command (with associated options if required: use--helpto see
which ones are supported):% python setup.py installIntegration with Rose and CylcIf you are intending to utilise theafterburnerPython package in combination
withRoseandCylc-- for example, to incorporate an Afterburner app into a Rose suite -- then you
should also install those packages onto your system.In addition to their respective GitHub project home pages (linked above), both
packages can be found on PyPI (Rose|Cylc).Note, however, that theafterburnerPython package should build and install
successfully without the Rose and Cylc packages being installed.DocumentationThe sphinx-based documentation for Afterburner may be generated by running thebuild_docssubcommand:% python setup.py build_docsThat command will build HTML documentation within the directorydoc/src/_build/html.
If desired, the documentation may then be installed into a target directory
using theinstall_docssubcommand:% python setup.py install_docs --dst-dir=<destination-dir> [--host=<hostname>]Alternatively, if preferred you can manually modify and run the shell script atdoc/src/build_docs.sh.TestingIf desired, the Afterburner unit tests may be run using the following command:% python setup.py testDepending on which packages are installed in your Python runtime environment,
some unit tests may be skipped.