Skip to content

Getting started

Welcome to idmtools! This section will help you get up and running quickly.

Prerequisites

  • Python: Versions 3.10, 3.11, 3.12, 3.13, or 3.14 are supported.
  • Operating System:
  • Windows 10+ Pro or Enterprise
  • Linux
  • macOS (10.15 Catalina or later)
  • Docker (optional): Required for Container platform

Installation

Choose an installation method based on your needs:

Full installation

Install all idmtools packages:

1
pip install idmtools[full]

This installs: core, CLI, models, and all platform plugins.

Platform-specific installation

Install only what you need:

1
pip install idmtools[idm]

Includes: core, CLI, models, COMPS platform

1
pip install idmtools[slurm]

Includes: core, CLI, models, General platform, Slurm platform

1
pip install idmtools[container]

Includes: core, CLI, models, General platform, Container platform

Next steps

Need help?