Windows Setup

Windows Setup#

All contributor installation steps can be completed without administration access. To achieve this choose “Install for my user only” when prompted.

Overview#

  • Install Python 3.12.3

  • Install uv with powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

  • Install git

  • Clone the PyMedPhys git repo

    • eg. git clone https://github.com/pymedphys/pymedphys.git

  • Run uv sync --extra all --group dev within the root of the repo

  • Run uv run -- pre-commit install

  • Install pandoc

You’re good to go.

More Advanced Options#

Opinionated Recommendations#

More details#

Install contributor system dependencies#

Python#

Download and install Python 3 for Windows, preferably from the official distribution.

Warning

At present, although PyMedPhys works with Python 3.10, not all of its dependencies do. For now, we recommend installing Python 3.7, 3.8 or 3.9.

VSCode#

Download and install VSCode. Make sure to tick the “Open with Code” boxes:

../../_images/open_with_code.png

Git and pandoc#

Use the following links to install git and pandoc.

If you don’t have admin access make sure to install within your user account. When installing git it will ask you what default text editor to use. If you don’t know what vim is make sure to change the default setting from vim to VSCode (that was just installed).

Install uv#

To install uv run the following within a command prompt:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

What this does is detailed in the Install uv docs. You will need to close and reopen your command prompt after installing uv.

Install the development version of PyMedPhys and pre-commit#

To download a copy of the PyMedPhys repository onto your machine run:

git clone https://github.com/pymedphys/pymedphys.git

Then change into the newly created directory by running:

cd pymedphys

Then install PyMedPhys and set up pre-commit by running:

uv sync --extra all --group dev
uv run -- pre-commit install

Install a Jupyter Lab kernel for the development install#

uv run -- python -m ipykernel install --user --name pymedphys
Contents