Skip to content

README.md

Latest commit

 

History

History
138 lines (94 loc) · 4.13 KB

README.md

File metadata and controls

138 lines (94 loc) · 4.13 KB

{{cookiecutter.project_name}}

pre-commit Tests status Linting status Documentation status ![License][license-badge]

{%- if cookiecutter.license == "MIT" %} [license-badge]: https://img.shields.io/badge/License-MIT-yellow.svg {%- elif cookiecutter.license == "BSD-3-Clause" %} [license-badge]: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg {%- elif cookiecutter.license == "GPL-3.0" %} [license-badge]: https://img.shields.io/badge/License-GPLv3-blue.svg {%- endif %}

{{cookiecutter.project_short_description}}

This project is developed in collaboration with the Centre for Advanced Research Computing, University College London.

About

Project Team

{{cookiecutter.author_given_names}} {{cookiecutter.author_family_names}} ({{cookiecutter.author_email}})

Research Software Engineering Contact

Centre for Advanced Research Computing, University College London ([email protected])

Built With

Getting Started

Prerequisites

{{cookiecutter.project_slug}} requires Python {{cookiecutter.min_python_version}}{% if cookiecutter.min_python_version != cookiecutter.max_python_version %}–{{cookiecutter.max_python_version}}{% endif %}.

Installation

We recommend installing in a project specific virtual environment created using a environment management tool such as uv. To install the latest development version of {{cookiecutter.project_slug}} using uv pip in the currently active environment run

uv pip install git+{{cookiecutter.__repo_url}}.git

Alternatively create a local clone of the repository with

git clone {{cookiecutter.__repo_url}}.git

and then install in editable mode by running

uv pip install -e .

Running Locally

How to run the application on your local system.

Running Tests

Tests can be run across all compatible Python versions in isolated environments using tox by running

tox

To run tests manually in a Python environment with pytest installed run

pytest tests

again from the root of the repository.

Building Documentation

The MkDocs HTML documentation can be built locally by running

tox -e docs

from the root of the repository. The built documentation will be written to site.

Alternatively to build and preview the documentation locally, in a Python environment with the docs dependency group installed, run

mkdocs serve

Roadmap

  • Initial Research
  • Minimum viable product <-- You are Here
  • Alpha Release
  • Feature-Complete Release {%- if cookiecutter.funder != '' %}

Acknowledgements

This work was funded by {{cookiecutter.funder}}. {%- endif %}