OpenGHG - a cloud platform for greenhouse gas data analysis and collaboration
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.
1 maintainer
Metadata
1 maintainer
Release files for openghg 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| openghg-0.1.0.tar.gz | 220.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openghg-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 456.8 kB
Release files / openghg-0.1.0.tar.gz
| Download URL | openghg-0.1.0.tar.gz |
|---|---|
| Size | 220.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5d8a72f492a45499c32bd0cd493c42b5f39d2bf03c51dcf87a6185482bdb39f9
|
|
BLAKE2b-256 checksum How to use checksums |
7c91b8e31c36526d9c55c5d4ce9b2433091f6f860e20feed6796fa1fc7944b31
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.13
|
Release files / openghg-0.1.0-py3-none-any.whl
| Download URL | openghg-0.1.0-py3-none-any.whl |
|---|---|
| Size | 236.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
45f6cee4a1e52e6a1ecc1788127fe74f122629a5e827db2619b261b320c1c05c
|
|
BLAKE2b-256 checksum How to use checksums |
a31974f1493f68a523c4185f2d504f1bf069dc4eb35c76e243c6ea9e01a41bc4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.13
|
