README.md

isoperiod

ISO 8601 period and duration arithmetic, including offsets from the natural boundary, for defining sampling resolution and periodicity in timeseries data

• GitHub | Documentation

Features

• TODO

Documentation

Documentation is built with Sphinx and deployed to GitHub Pages.

• Live site: https://richjam.github.io/isoperiod/
• Preview locally: make docs-serve (serves at http://localhost:8000)
• Build: make docs-build

API documentation is auto-generated from docstrings using sphinx-autodoc.

Development

To set up for local development:

git clone git@github.com:richjam/isoperiod.git
cd isoperiod
uv sync

Run tests:

uv run pytest

Run quality checks (format, lint, type check, test):

make qa

Citation

If you use this software, please cite it using the metadata in CITATION.cff.

Licence

MIT

Built with Cookiecutter and the NERC-CEH/fdri-cookiecutter-templates template.