turtwig

Utility library and starter code for medical data analysis. See documentations here.

Installation

Install via one of the options below

uv

Ensure that you’ve run uv init or that a pyproject.toml file exists in the current directory. Then, run

uv add "turtwig @ git+https://github.com/UWA-Medical-Physics-Research-Group/turtwig"

pip

To install the package with pip, run

pip install https://github.com/UWA-Medical-Physics-Research-Group/turtwig/releases/latest/download/turtwig-0.1.0-py3-none-any.whl

Nix Templates

You can quickly initialise a new Python 3.12.7 project if you have installed Nix. Initialise a folder for your project, cd into it and run

# If experimental features are enabled
nix flake init -t git+https://github.com/UWA-Medical-Physics-Research-Group/turtwig.git#python312

# if experimental features are NOT enabled
nix --extra-experimental-features flakes flake init -t git+https://github.com/UWA-Medical-Physics-Research-Group/turtwig.git#python312

Then, run one of the commands below to install turtwig

# remember to add --extra-experimental-features flags if they are not enabled
nix develop -c uv sync  # use if uv is NOT installed, OR you want to use nix
uv sync   # use if uv IS installed and you don't want to use nix

See the list of templates here.