Skip to content

Developer guide

If you want to make changes to springtime, you can create an editable installation from source.

If your work might be useful for others, we encourage you to contribute your changes to the package. We are happy to help!

Instructions on adding datasets or adding models are part of the user guide.

This page lists everything you need to know about code formatting, testing, and writing documentation.

Install from source

Follow the installation instructions to set up your environment. Then clone the springtime git repo and create an editable installation with development dependencies:

# Clone the repo
git clone
cd springtime
pip install --editable .[dev,docs,extras]

Now, whenever, you change the source code and restart the python interpreter, your changes will be reflected.

Using hatch

Alternatively, you can use hatchhatch:

# Create development environment for springtime
hatch env create

# Enter/activate development environment
hatch shell
springtime --help
exit  # get out/deactivate

# Alternatively, use hatch run to execute commands in default env, e.g.
hatch run springtime --help
hatch run pytest

Linting and formatting

We use ruff for linting and black for formatting. Mypy is used for type checking.

# Apply black automatic formatting to both src/ and tests/
hatch run black src tests

# See what ruff can do for you
hatch run ruff help

# Lint all files in src/ and tests/ with all linters
hatch run ruff check src tests

# Try to automatically fix issues
hatch run ruff check src tests --fix

# Run static type checking
hatch run mypy --install-types  # say yes
hatch run mypy --ignore-missing-imports src tests

# Run all of the above with a single command
hatch run quality-checks


Pytest is used for running tests.

# Run all tests in tests/
hatch run pytest

# Run all tests from one file
hatch run pytest tests/

# Run a single test
hatch run pytest tests/

To test examples in docstrings use:

hatch run doctest <file to test>
# For example
hatch run doctest src/springtime/


Documentation is build with mkdocs

# Get help for mkdocs
hatch run mkdocs --help
hatch run mkdocs serve --help

# Start a development server with auto reloads
hatch run mkdocs serve

# Build the documentation for deployment
hatch run mkdocs build --clean --strict

Docker build

The docker image is hosted on GitHub Container Registry (GHCR).

You need to setup a personal access token following the instructions here.

Then build and push the image to GHCR:

# In the root of the repository
docker build -t .
docker push

Contributing guidelines

We welcome contributions from everyone. Please use our GitHub issue tracker for questions, ideas, bug reports, or feature requests.

If you want to make a pull request:

  1. discuss your idea first, before putting in a lot of effort
  2. refer to the this documentation
  3. if needed, fork the repository to your own Github profile
  4. work on your own feature branch
  5. make sure the existing tests still work and add new tests (if necessary)
  6. update or expand the documentation;
  7. make sure your code follows the style guidelines

Don't hesitate seek assistance with any of these steps. We're happy to help!

Code of conduct

By participating in this project, you agree to abide by the code of conduct as spelled out in the contributor-covenant version 2.1