FastSIMUS 0.0.1

Fast simulator for medical ultrasound, based on SIMUS/MUST

FastSIMUS

Fast simulator for medical ultrasound, based on SIMUS/MUST

Development

This project uses Flox for reproducible system dependencies (Python, uv, CUDA runtime on Linux), uv for Python package management, and Poe the Poet for running tasks.

Setup

Install Flox, then from the repository root:

flox activate

This creates the uv virtual environment and runs poe install.

For uv-only development without Flox, install uv. On macOS and Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

For Windows, see the official installation instructions.

For development, you can optionally install the task runner:

uv tool install poethepoet

This puts poe in your path; otherwise, run uv run poe instead of poe.

Pre-commit Hooks

This project uses prek (a faster Rust-based alternative to pre-commit):

# Install hooks
uv run prek install

# Run manually
uv run prek run --all-files

Available Commands

Run inside flox activate (or prefix with flox activate --):

• poe test - Run tests affected by recent changes
• poe lint - Format and lint code
• poe docs - Build and serve documentation

Without Flox: uv run poe test, uv run poe lint, etc.