Dashboard Statistics Library

Library for generating statistics for the UKRDC dashboard

Usage

See PKG-README for user installation and usage.

Developer notes

⚠️This is a public repository all script output should be pointed at the .do_not_commit directory at the root of this project to prevent accidental committing of data. Tox testing be run and passing before any commits of notebooks or other code.

Installation

poetry install

Iterating version numbers

The library should follow semantic versioning.

Use Poetry to set the package version.

E.g. poetry version patch for fix releases, poetry version minor for new functionality releases, or poetry version major for breaking-change releases.

Packaging and Publishing

Publishing the library is handled automatically by GitHub Actions. The published version includes only the core library files, metadata, and PKG-README.md. Demo notebooks, and tests, are not included.

To publish a new release:

• Ensure all tests are passing on the master branch.
• Update the package version number (see above section) on the master branch, commit, and push.
• Create a new GitHub release named after the version number, with a prefixed lowercase "v". E.g. v1.0.0
  • Above the release name, create a new tag identical to the release name
• Publish the release. GitHub Actions will ensure all tests pass, then publish the library to PyPI.

Running the demo notebooks

Install additional demo notebook dependencies with

poetry install --with demo

Code Structure

models

Generic reusable Pydantic models (e.g. for plot types)

calculators

API-stable stats calculators