MAINTAINERS.md

Maintainer Notes

This file documents notes for maintainers of the repository.

data_download

This directory contains a Python package wsfr-download that provides a CLI for downloading approved feature datasets. Package metadata, including abstract dependencies, are defined in the pyproject.toml file.

Pinning requirements

In order to have a reproducible environment, we use pip-tools to pin dependencies. From the repository root, run

pip-compile data_download/pyproject.toml

data_reading

This directory contains a Python package wsfr-read that provides sample code for reading data downloaded by wsfr-download. Package metadata, including abstract dependencies, are defined in the pyproject.toml file. This package will be included in the runtime container image and dependencies will be pinned as part of locking the runtime environment.

Tests

You can run some basic integration tests with

pytest data_reading

This assumes you've downloaded all of the hindcast data, i.e., you've run python -m wsfr_download bulk data_download/hindcast_test_config.yml.