Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.87 KB

builders.rst

File metadata and controls

53 lines (33 loc) · 1.87 KB
Raw

Builders

Simulation Builder

The follow demonstrates how to build a sweep using the standard builder, :py~idmtools.builders.simulation_builder.SimulationBuilder

This example uses the following model.

../../idmtools_test/idmtools_test/inputs/python/model1.py

It then builds sweeps through Arms

../../examples/builders/simulation_builder.py

See :py~idmtools.builders.simulation_builder.SimulationBuilder for more details.

Arm Experiment Builder

The follow demonstrates how to build a sweep using :py~idmtools.builders.arm_simulation_builder.ArmSimulationBuilder

This example uses the following model.

../../idmtools_test/idmtools_test/inputs/python/model1.py

It then builds sweeps through Arms

../../examples/builders/arm_experiment_builder_python.py

See :py~idmtools.builders.arm_simulation_builder.ArmSimulationBuilder for more details

Multiple argument sweep

The follow demonstrates how to build a sweep when multiple arguments are required at the same time. Typically, defining sweeps per argument is best like in the example Simulation Builder but in some cases, such as when we need all parameters to create an object, we want these parameters passed to a single callback at the same time. This example uses the following model.

../../idmtools_test/idmtools_test/inputs/python/model1.py

We then make a class within our example script that requires the parameters a, b, and c be defined at creation time. With this defined, we then add our sweep callback.

../../examples/builders/multi_argument_sweep.py