Skip to content

API reference

Complete API documentation for idmtools.

Core modules

idmtools.core

Core classes and functionality

Key Classes:

  • Platform - Platform factory and management
  • Entity - Base entity class
  • ItemType - Entity type enumeration

idmtools.models

Model implementations

Modules:

  • python - Python model support
    • PythonTask
    • JSONConfiguredPythonTask
    • SingularityJSONConfiguredPythonTask
  • r - R model support
  • templated_script_task - Templated models

idmtools.platforms

Platform implementations

Platform Types:

  • comps - COMPS platform
  • slurm - Slurm platform
  • container - Container platform
  • process - Local process platforms

Data analysis

Analysis framework for post-processing simulation outputs

Key Classes:

  • IAnalyzer - Abstract base class for all analyzers
  • AnalyzeManager - Run analyzers locally with a parallel worker pool
  • PlatformAnalysis - Run analyzers remotely on COMPS via SSMT
  • DownloadAnalyzer, CSVAnalyzer, TagsAnalyzer, AddAnalyzer - Built-in analyzers

API navigation

Browse by module or use the search function to find specific classes and functions.

See also