Skip to content

Installation

MedPipe requires Python 3.12 or later.

Standard installation

Install the published package from PyPI:

pip install medpipe

Check that the installation worked:

python -c "import medpipe; print(medpipe.__version__)"

Optional dependencies

Reading Excel files (.xlsx and .xls) needs the openpyxl package, which is not installed by default. Install it with the excel extra:

pip install "medpipe[excel]"

Installing from source (developer setup)

To set up a local development environment and contribute to MedPipe, clone the GitHub repository:

git clone git@github.com:Surgical-Recovery-and-Safety-Lab/medpipe.git
cd medpipe

Install the package in editable mode with the development dependencies:

pip install -e ".[dev]"

The dev extra includes the test tools (pytest) and the docs extra (mkdocs, linting and type-checking tools). To preview this documentation locally:

mkdocs serve

Next step

Once the package has been installed, try the quickstart example.