Skip to content

Installation

Quick install

1
pip install idmtools_calibra

Prerequisites

  • Windows 10+ Pro/Enterprise, Linux, or macOS
  • Python: Versions 3.10, 3.11, 3.12, 3.13, or 3.14 are supported.

Detailed installation

1. Create a virtual environment

1
python -m venv v-calibra

2. Activate it

1
v-calibra\Scripts\activate

1
source v-calibra/bin/activate

3. Install idmtools_calibra

1
pip install idmtools_calibra

Linux additional dependency

On Linux, also install the keyring backend: 

1
pip install keyrings.alt

4. Verify the installation

1
2
import idmtools_calibra
print(idmtools_calibra.__version__)

Corporate or offline environments

If you are behind a corporate proxy or need to point pip at a custom index, create a pip configuration file:

C:\Users\<Username>\pip\pip.ini: 

1
2
[global]
index-url = https://pypi.org/simple

$HOME/.config/pip/pip.conf: 

1
2
[global]
index-url = https://pypi.org/simple

Development install

For contributing to idmtools_calibra or running tests:

1. Clone the repository

1
2
git clone https://github.com/InstituteforDiseaseModeling/idmtools_calibra.git
cd idmtools_calibra

2. Create and activate a virtual environment

1
2
3
4
5
python -m venv v-calibra
# Windows:
v-calibra\Scripts\activate
# Linux/macOS:
source v-calibra/bin/activate

3. Bootstrap the dev environment

1
python .dev_scripts/bootstrap.py

This installs all package dependencies and development tools.

Alternatively, install manually with test extras:

1
pip install -e ".[test]"

4. Run the tests

1
2
3
cd tests
make test-all          # run all tests
make test-unittests    # fast unit tests only

5. Build documentation locally

1
2
make docs        # build
make docs-serve  # build and serve at http://127.0.0.1:8000