Linux Setup#
Install prerequisites#
Install Git and uv. On Linux, the standalone uv installer is:
curl -LsSf https://astral.sh/uv/install.sh | sh
Open a new terminal if uv is not yet on your PATH.
Create the development environment#
Run these commands from the directory where you keep your projects. If you will contribute through a fork, substitute your fork’s clone URL.
git clone https://github.com/pymedphys/pymedphys.git
cd pymedphys
uv python install 3.14
uv sync --python 3.14 --locked
uv run pre-commit install
The current source supports Python 3.12, 3.13, and 3.14. Python 3.14 matches the quick CI run. uv can install Python for you, so a separate Python or pipx installation is not required.
uv sync creates the repository’s .venv and installs an editable copy of
PyMedPhys with the contributor dependencies. Run project commands with
uv run from the repository root.
Install Pandoc if needed for notebook
or document conversion (for example, sudo apt-get install pandoc on
Debian/Ubuntu). The HTML documentation build uses the Python dependencies
installed above.
Next steps#
Run
uv run pymedphys dev tests -m "not slow".Follow the documentation guide to build the site.
Read the workflow guide before opening a PR.
For notebooks, register the project kernel.
An editor such as Visual Studio Code is optional.