Quick start

Installation

Clone the repository :

git clone [email protected]:os-climate/hazard.git
cd hazard

Then use either pdm (recommended):

pip install pdm
pdm config venv.with_pip True
pdm install

Or virtualenv:

python -m venv .venv
source .venv/bin/activate
pip install -e .

Usage

In a virtual environment

A command line interface is exposed with the package. For example, this code snippet will run a cut-down version of a "days above temperature" indicator and write the output to $HOME/hazard_example :

source .venv/bin/activate
mkdir -p $HOME/hazard_example
os_climate_hazard days_tas_above_indicator --store $HOME/hazard_example

In a docker container

First, build the image.

docker build -t os-hazard-indicator -f dockerfiles/Dockerfile .

Then, you can run an example the following way. In the example, we save the data locally to /data/hazard-test-container in the container. To have access to the output once the container finished running, we are mounting /data from the container to $HOME/data locally.

docker run -it -v $HOME/data:/data os-hazard-indicator os_climate_hazard days_tas_above_indicator --store /data/hazard-test-container

In a CWL (Common Workflow Language) workflow

Contributing

Patches may be contributed via pull requests from forks to https://github.com/os-climate/hazard.

All changes must pass the automated test suite, along with various static checks.

The easiest way to run these is via:

pdm run all

Hazard modelling

For more modelling-specific information, see HAZARD.md.