Skip to content

Climate Data Pipeline Installation

This package contains pipelines and utilities to systematically extract, format, and downscale data from ERA5 climate models and CMIP6 climate forecasts.

Developer Installation

Instructions using conda:

  1. Clone this repository.

    Over ssh:

    git clone git@github.com:ihmeuw/climate-data.git
    

    Over https:

    git clone https://github.com/ihmeuw/climate-data.git
    

  2. Create a new conda environment.

    conda create -n climate-data python=3.12
    conda activate climate-data
    
  3. Install poetry and the project dependencies.

    pip install poetry
    cd climate-data
    poetry install
    

Pre-commit

pre-commit hooks run all the auto-formatting (ruff format), linters (e.g. ruff and mypy), and other quality checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

pre-commit install

Or if you want them to run only for each push:

pre-commit install -t pre-push

Or if you want e.g. want to run all checks manually for all files:

poetry run pre-commit run --all-files

pre-commit is configured in the .pre-commit-config.yaml file in the repository root. All auto-formatting, linting, and other tooling is configured in the pyproject.toml file.