Tools and apps for processing numerical climate model data
Reason this release was yanked:
Syntax errors in setup.py file
Project description
Afterburner Package
What 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's Unified 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.
License
Afterburner 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.
Dependencies
The afterburner
package depends upon the following packages, each of which have
their own dependencies.
- scitools-iris (version 2.1 or later)
- pyparsing
- windspharm
- sphinx (only required if you intend to build and install the documentation set)
- nose (only required if you intend to run the unit tests)
Installation
The afterburner
package can be installed from PyPI
or conda-forge.
To install from PyPI:
pip install metoffice-afterburner
To install from conda-forge:
conda install -c conda-forge metoffice-afterburner
You may also install directly from the source distribution. After downloading the package tarball, unpack it, change to the source directory, then enter the following command (with associated options if required):
python setup.py install
Integration with Rose and Cylc
If you are intending to utilise the afterburner
Python package in combination
with Rose and Cylc
-- 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 the afterburner
Python package should build and install
successfully without the Rose and Cylc packages being installed.
Documentation
The sphinx-based documentation for Afterburner may be generated by running the
build_docs
subcommand:
python setup.py build_docs
That command will build HTML documentation within the directory doc/src/_build/html
.
If desired, the documentation may then be installed into a target directory
using the install_docs
subcommand:
python setup.py install_docs --dst-dir=<destination-dir> [--host=<hostname>]
Alternatively, if preferred you can manually modify and run the shell script at
doc/src/build_docs.sh
.
Testing
If desired, the Afterburner unit tests may be run using the following command:
python setup.py test
Depending on which packages are installed in the Python runtime environment, some unit tests may be skipped.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for metoffice-afterburner-1.3.2b1.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33562708e855f66fbd4a5c69fd201e86e97da788e32b173d985092bdc343eeab |
|
MD5 | d9327997688f4574aabee704efb2a33e |
|
BLAKE2b-256 | 3d575e3fcb4b54de16684ddbd50b5599c440b589589f6c44b02c4745ae334bb5 |