citation-tools

A collection of generic tools and utilities for citation management and metrics.

Setting up the project

1. Clone the repo, e.g. Git over SSH (assuming you've set up SSH keys correctly):

git clone git+ssh://git@github.com/ISARICResearch/citation-tools

If you're outside the ISARICResearch GitHub organisation, or haven't been granted read/write access to the repository as an external collaborator, contact a maintainer (listed at the bottom of the README).

2. Install Astral uv:

python3 -m pip install uv

By default uv will create a new virtual environment in the working directory named .venv where it will make all dependency changes. If you don't want this, and instead want to re-use a pre-existing, preferred virtual environment then specify its path via the UV_PROJECT_ENVIRONMENT environment variable:

export UV_PROJECT_ENVIRONMENT="/path/to/preferred/virtual/env"

3. Install all project dependencies (package + development + optional), excluding the project itself, with uv

uv sync --verbose --all-extras --all-groups --no-install-project

Now you're ready to go.

Maintainers

• Sandeep Murthy - sandeep.murthy@ndm.ox.ac.uk