User Guide¶

Complete guide to using idmtools for disease modeling workflows.

Overview¶

This guide covers all aspects of using idmtools:

• Creating and running simulations
• Managing experiments
• Working with different platforms
• Analyzing results
• Best practices

Key Concepts¶

• Task — Defines what to run. A task wraps your model script, its parameters, and any assets it needs.
• Simulation — A single run of a task with a specific set of parameters.
• Experiment — A collection of simulations, typically created from a parameter sweep.
• Suite - A collection of experiments, it is optional for most of the cases.
• Platform — Where your experiment runs (COMPS, Slurm, Container, Process).
• Assets — Files your simulations need (scripts, data files, config files, container images).
• Analyzer — Post-processing logic that runs after simulations complete.

Basic Workflow¶

• Write your model — Create a script that accepts parameters and produces output.
• Define a task — Wrap your model in an idmtools Task.
• Build simulations — Use a SimulationBuilder to sweep over parameters.
• Create an experiment — Group your simulations into an experiment.
• Run — Submit the experiment to a platform.
• Analyze — Use an Analyzer to aggregate results.

Topics¶

Core Concepts¶

• Creating Simulations & Experiments - Build simulations and organize them into experiments
• Asset Management - Handle files and resources
• Parameter Sweeps - Run parameter variations
• Data Analysis - Process simulation outputs with Analyzers, AnalyzeManager, and PlatformAnalysis

Quick Navigation¶

Getting Help¶

• Check the FAQ
• See Tutorials for examples
• Browse API Reference for details