ISARIC Dataset Metadata

Static site consisting of dataset metadata pages that is deployed to:

https://dataset.isaric.org

Set up the project

1. In a Python 3.12+ virtual environment install the Astral UV dependency/package manager with pip:

python3 -m pip install uv

By default UV will make all dependency-related changes inside a new .venv subfolder within the working directory - if you prefer to use the pre-existing virtual environment then export its path to the UV_PROJECT_ENVIRONMENT environment variable:

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

2. Install (or sync) all the project dependencies into the environment with the command:

uv sync --verbose --all-groups --all-extras --no-install-project --no-cache --refresh --inexact

Making changes

The source files for the HTML pages generated as part of the static site are located in the docs subfolder, and written in the reStructuredText markup language. They have the .rst file suffix.

The main page is index.rst, which contains the content for the landing page at https://dataset.isaric.org. The remaining .rst pages are organised around a folder structure for individual projects associated with datasets, e.g. navis for the NAVIS project. Within each project subfolder, e.g. navis , the index.rst determines the content of the landing page for the dataset at https://dataset.isaric.org/, e.g. https://dataset.isaric.org/navis.

Build the static site

The documentation site is generated with the Sphinx dependency. To build and view the site locally use the command:

make -C docs html

and open the docs/_build/html/index.html in a browser.