Installation

The easiest way to install OpenGHG is using pip, first ensure you have a recent version of Python installed.

Checking your Python installation

OpenGHG is developed and tested on Linux and MacOS, support for Windows is planned.

To install OpenGHG, you first need to install Python >= 3.8. To check if you have Python 3.8 installed type;

python -V

This should print out the version number of the Python you have available. If the version number is 2.x then you must use the python3 command, if this this is the case, try;

python3 -V

and see if you have a Python 3 that has a version number >= 3.8. If so, please use python3 instead of python.

If you don’t have Python >= 3.8 installed, then you can install Python either via your package manager if using Linux or Homebrew on MacOS. An alternative for both platforms is anaconda.

Installation

We highly recommend creating a separate virtual environment for openghg. This ensures the correct versions of libraries can be installed without making changes to versions of libraries needed for other projects / programs.

pip

First create a virtual environment

python -m venv /path/to/env/openghg_env
# Activate the environment
source /path/to/env/bin/activate

Here change /path/to/env with your own path.

Next install OpenGHG

pip install openghg

conda

First create and activate a conda environment

conda create --name openghg_env
# Activate the environment
conda activate openghg_env

Next install OpenGHG from our conda channel

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

Configuration

On the first run on OpenGHG a configuration file will be created in your home folder. On Linux this should be under /home/<your username>/.config/openghg/openghg.conf or on macOS /Users/<your username>/.config/openghg/openghg.conf. In this file we set the path for the object store. By default the object store will be created at /home/<your username>/openghg_store. To modify this path open the config file with a text editor and change the value assigned to local_store.

[object_store]
local_store = "/home/<your username>/openghg_store"

Remember to replace <your username> with your username.

Deprecation of OPENGHG_PATH

If you’ve previously used OpenGHG and worked through our tutorials you might have encountered the need to set the OPENGHG_PATH environment variable. Now that we’ve moved to a configuration file this is not longer used. If you previously set a custom path using the variable please update the configuration file as below.

Developers

For developers please see the Getting setup documentation.