Installation

Requirements

• Python >= 3.10
• pip >= 23
• setuptools >= 67

Setup Instructions

1. Create a Virtual Environment

We recommend using a virtual environment to isolate dependencies.

Using venv:

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Using conda:

conda create -n spinereport python=3.10
conda activate spinereport

2. Install SpineReport

From source:

git clone https://github.com/ivadomed/SpineReport.git
cd SpineReport
pip install .

3. Verify Installation

Test the installation by checking the help:

spinereport --help

Troubleshooting

If you encounter issues during installation, try:

1. Update pip and setuptools:

   pip install --upgrade pip setuptools
   

2. Install in development mode:

   pip install -e .
   

3. Check your Python version:

   python --version  # Should be >= 3.10
   

For additional support, please open an issue.