https://github.com/metoffice/cube_helper

A Python module, for easier manipulation of Cubes with Iris
https://github.com/metoffice/cube_helper

iris python science

Last synced: 3 months ago
JSON representation

A Python module, for easier manipulation of Cubes with Iris

• Host: GitHub
• URL: https://github.com/metoffice/cube_helper
• Owner: MetOffice
• License: bsd-3-clause
• Created: 2019-07-19T14:06:43.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-08-24T10:31:35.000Z (almost 3 years ago)
• Last Synced: 2025-11-23T10:07:36.588Z (6 months ago)
• Topics: iris, python, science
• Language: Python
• Homepage: https://cube-helper.readthedocs.io/
• Size: 11.5 MB
• Stars: 3
• Watchers: 2
• Forks: 4
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## Cube Helper

![Tests](https://github.com/MetOffice/cube_helper/workflows/Tests/badge.svg) 

![PEP8](https://github.com/MetOffice/cube_helper/workflows/PEP8/badge.svg) 

[![Documentation Status](https://readthedocs.org/projects/cube-helper/badge/?version=latest)](https://cube-helper.readthedocs.io/en/latest/?badge=latest) 

![Licence](https://img.shields.io/github/license/MetOffice/cube_helper) 

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4073150.svg)](https://doi.org/10.5281/zenodo.4073150)

Cube Helper is a package to make equalisation, concatenation, and analysis of 

[Iris](https://scitools-iris.readthedocs.io/)

cubes easier. It is written with reasearchers in mind and provides a good degree of

abstraction from many Iris functions and methods.

 

The package is written entirely in Python and provides a number of reusable methods.

## Documentation

cube_helper's documentation is available from https://cube-helper.readthedocs.io/

 

## Requirements

Please ensure you have the following dependencies installed:  

`cf_units`  

`iris`  

`numpy`

## Installing

cube_helper is already installed at several sites. Please see their internal documentation for details of how to access it there. 

To install your own copy, then cube_helper is available via PyPI and conda-forge:

`pip install cube-helper`

`conda install -c conda-forge cube_helper`

Alternatively, make sure that all of the requirements are installed, then clone the repository

and set your Python environment to point to your copy, for example:  

`git clone https://github.com/MetOffice/cube_helper.git`  

`export PYTHONPATH=`  

## Contributing  

If you want to contribute to Cube Helper be sure to review the 

[contribution guidelines](https://github.com/MetOffice/cube_helper/blob/master/CONTRIBUTING.md).

## License

[BSD-3 License](https://github.com/MetOffice/cube_helper/blob/master/LICENSE)