Skip to main content

OpenGHG - a cloud platform for greenhouse gas data analysis

Project description

OpenGHG logo

OpenGHG - a cloud platform for greenhouse gas data analysis and collaboration

License codecov OpenGHG tests

OpenGHG is a project based on the prototype HUGS platform which aims to be a platform for collaboration and analysis of greenhouse gas (GHG) data.

The platform will be built on open-source technologies and will allow researchers to collaborate on large datasets by harnessing the power and scalability of the cloud.

For more information please see our documentation.

Cloud

You can login to our OpenGHG Cloud JupyterHub and use OpenGHG in the cloud. This will allow you to use the full power of OpenGHG from your local device. Once you're logged in please checkout some of our tutorials to help you get started.

Install locally

To run OpenGHG locally you'll need Python 3.7 or later on Linux or MacOS, we don't currently support Windows.

Install OpenGHG

You can install OpenGHG using pip or conda. We recommend you create a virtual environment first

pip

$ python -m venv openghg_env

Then activate the environment

$ source openghg_env/bin/activate

Then install OpenGHG

$ pip install openghg

conda

Create a conda environemnt called openghg_env and enable the use of conda-forge

$ conda create --name openghg_env

Activate the environment

$ conda activate openghg_env

Then install OpenGHG and its dependencies from our conda channel and conda-forge.

$ conda install --channel conda-forge --channel openghg openghg

Set environment variable

OpenGHG expects an environment variable OPENGHG_PATH to be set. This tells OpenGHG where to place the local object store.

Please add the following line to your shell profile (~/.bashrc, ~/.profile, ...).

OPENGHG_PATH=/your/selected/path

We recommend a path such as /home/your_username/openghg_store.

Developers

If you'd like to contribute to OpenGHG please see the contributing section of our documentation. If you'd like to take a look at the source and run the tests follow the steps below.

Clone

$ git clone https://github.com/openghg/openghg.git

Install dependencies

We recommend you create a virtual environment first

$ python -m venv openghg_env

Then activate the environment

$ source openghg_env/bin/activate

Then install the dependencies

$ cd openghg
$ pip install --upgrade pip wheel
$ pip install -r requirements-dev.txt

Run the tests

To run the tests

$ pytest -v tests/

NOTE: Some of the tests require the udunits2 library to be installed.

The udunits package is not pip installable so we've added a separate flag to specifically run these tests. If you're on Debian / Ubuntu you can do

$ sudo apt-get install libudunits2-0

You can then run the cfchecks marked tests using

$ pytest -v --run-cfchecks tests/

If all the tests pass then you're good to go. If they don't please open an issue and let us know some details about your setup.

Documentation

For further documentation and tutorials please visit our documentation.

Community

If you'd like further help or would like to talk to one of the developers of this projet, please join our Gitter at gitter.im/openghg/lobby.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openghg-0.1.0.tar.gz (220.7 kB view hashes)

Uploaded source

Built Distribution

openghg-0.1.0-py3-none-any.whl (236.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page