Overview¶

StudPy is a collection of tools designed to support scientific studies by providing:

• parameters sapmling definition and case dataset generation
• Ceation and preparation of process inputs
• batch management for simulation execution and results aggregation

The following schema illustrates the main objects:

Study¶

Study represents a full simulation study campaign:

1. Parameter space is defined via CaseBuilder
2. All simulation cases are generated
3. Each case can be executed via target builders
4. Inputs for external solvers are created per case

A Study is configured by combining:

• parameter definitions (Param)
• parameter generation strategies (Config)
• sampling methods
• inputs builders

The resulting configuration defines the simulation space explored by the study.

The Study class is the central orchestration object of the framework.

It connects: - parameter sampling (CaseBuilder) - case generation - simulation inputs builder (Abstract InputsBuilder)

See API Study

Batch¶

Batch provides utilities for executing large numbers of simulation cases.

Without Batch, each simulation would need to be launched manually.

The Batch module automates this process and adds support for: - sequential or parallel execution - progress reporting - execution hooks - result collection - validation of simulation outputs - error detection and logging

See API BatchExecCmdIter

Case Builder¶

See Case Builder

Inputs Builder¶

See API OneFileInputsBuilder

Typical Configuration Workflow¶

1. Define parameters
2. Select generation strategies
3. Configure LHS samplers
4. Build CaseBuilder
5. Create a Study
6. Generate and execute cases