Skip to content

⚙️ Installation Guide for TumorTwin

TumorTwin is tested with Python 3.11, and we recommend using a virtual environment for a clean setup.

Prerequisites

  • Python (tested on Python 3.11)
  • git
  • A package manager like Anaconda or pip

  1. Install Anaconda (if not already installed):
    https://docs.anaconda.com/anaconda/install

  2. Create a new environment with Python 3.11:

conda create -n tumortwin python=3.11 anaconda
  1. Activate the environment:
conda activate tumortwin

Option 2: Using venv (lightweight setup)

  1. Create a virtual environment:
python3.11 -m venv tumortwin-env
  1. Activate it:

  2. On macOS/Linux:

    source tumortwin-env/bin/activate
    
  3. On Windows:

    .\tumortwin-env\Scripts\activate
    

Install TumorTwin

  1. Clone the repository:
git clone https://github.com/OncologyModelingGroup/TumorTwin.git
cd TumorTwin
  1. Install dependencies:

  2. Standard installation:

    pip install .
    
  3. Development mode (editable install + dev tools):

    pip install -e ".[dev]"
    

Optional: Running the Demo

Open HGG_Demo.ipynb or TNBC_Demo.ipynb in Jupyter, VS Code, Colab or your preferred IDE.