ronswanson.simulation_builder module

class ronswanson.simulation_builder.SLURMTime(hrs: int = 0, min: int = 10, sec: int = 0)

Bases: object

hrs: int = 0

min: int = 10

sec: int = 0

__init__(hrs: int = 0, min: int = 10, sec: int = 0) → None

class ronswanson.simulation_builder.JobConfig(time: ronswanson.simulation_builder.SLURMTime, n_cores_per_node: int)

Bases: object

time: SLURMTime

n_cores_per_node: int

__init__(time: SLURMTime, n_cores_per_node: int) → None

class ronswanson.simulation_builder.GatherConfig(time: ronswanson.simulation_builder.SLURMTime, n_cores_per_node: int, n_gather_per_core: int)

Bases: JobConfig

n_gather_per_core: int

__init__(time: SLURMTime, n_cores_per_node: int, n_gather_per_core: int) → None

class ronswanson.simulation_builder.SimulationConfig(time: ronswanson.simulation_builder.SLURMTime, n_cores_per_node: int, n_mp_jobs: int, run_per_node: Union[int, NoneType] = None, use_nodes: bool = False, max_nodes: Union[int, NoneType] = None, linear_execution: bool = False, num_meta_parameters: Union[int, NoneType] = None)

Bases: JobConfig

n_mp_jobs: int

run_per_node: Optional[int] = None

use_nodes: bool = False

max_nodes: Optional[int] = None

linear_execution: bool = False

num_meta_parameters: Optional[int] = None

__init__(time: SLURMTime, n_cores_per_node: int, n_mp_jobs: int, run_per_node: Optional[int] = None, use_nodes: bool = False, max_nodes: Optional[int] = None, linear_execution: bool = False, num_meta_parameters: Optional[int] = None) → None

class ronswanson.simulation_builder.JobConfigStructure(time: Union[ronswanson.simulation_builder.SLURMTime, NoneType] = None, n_cores_per_node: Union[int, NoneType] = None)

Bases: object

time: Optional[SLURMTime] = None

n_cores_per_node: Optional[int] = None

__init__(time: Optional[SLURMTime] = None, n_cores_per_node: Optional[int] = None) → None

class ronswanson.simulation_builder.GatherConfigStructure(time: Union[ronswanson.simulation_builder.SLURMTime, NoneType] = None, n_cores_per_node: Union[int, NoneType] = None, n_gather_per_core: int = '???')

Bases: JobConfigStructure

n_gather_per_core: int = '???'

__init__(time: Optional[SLURMTime] = None, n_cores_per_node: Optional[int] = None, n_gather_per_core: int = '???') → None

class ronswanson.simulation_builder.SimulationConfigStructure(time: Union[ronswanson.simulation_builder.SLURMTime, NoneType] = None, n_cores_per_node: Union[int, NoneType] = None, n_mp_jobs: int = '???', run_per_node: Union[int, NoneType] = None, use_nodes: bool = False, max_nodes: Union[int, NoneType] = None, linear_execution: bool = False)

Bases: JobConfigStructure

n_mp_jobs: int = '???'

run_per_node: Optional[int] = None

use_nodes: bool = False

max_nodes: Optional[int] = None

linear_execution: bool = False

__init__(time: Optional[SLURMTime] = None, n_cores_per_node: Optional[int] = None, n_mp_jobs: int = '???', run_per_node: Optional[int] = None, use_nodes: bool = False, max_nodes: Optional[int] = None, linear_execution: bool = False) → None

class ronswanson.simulation_builder.YAMLStructure(import_line: str = '???', parameter_grid: str = '???', out_file: str = '???', clean: bool = True, simulation: ronswanson.simulation_builder.SimulationConfigStructure = SimulationConfigStructure(time=None, n_cores_per_node=None, n_mp_jobs='???', run_per_node=None, use_nodes=False, max_nodes=None, linear_execution=False), gather: Union[ronswanson.simulation_builder.GatherConfigStructure, NoneType] = None, num_meta_parameters: Union[int, NoneType] = None, finish_missing: bool = False)

Bases: object

import_line: str = '???'

parameter_grid: str = '???'

out_file: str = '???'

clean: bool = True

simulation: SimulationConfigStructure = SimulationConfigStructure(time=None, n_cores_per_node=None, n_mp_jobs='???', run_per_node=None, use_nodes=False, max_nodes=None, linear_execution=False)

gather: Optional[GatherConfigStructure] = None

num_meta_parameters: Optional[int] = None

finish_missing: bool = False

__init__(import_line: str = '???', parameter_grid: str = '???', out_file: str = '???', clean: bool = True, simulation: SimulationConfigStructure = SimulationConfigStructure(time=None, n_cores_per_node=None, n_mp_jobs='???', run_per_node=None, use_nodes=False, max_nodes=None, linear_execution=False), gather: Optional[GatherConfigStructure] = None, num_meta_parameters: Optional[int] = None, finish_missing: bool = False) → None

class ronswanson.simulation_builder.SimulationBuilder(parameter_grid: ParameterGrid, out_file: str, import_line: str, simulation_config: SimulationConfig, gather_config: Optional[GatherConfig] = None, num_meta_parameters: Optional[int] = None, clean: bool = True, finish_missing: bool = False)

Bases: object

The simulation builder class constructs the scripts needed for building the table model database

__init__(parameter_grid: ParameterGrid, out_file: str, import_line: str, simulation_config: SimulationConfig, gather_config: Optional[GatherConfig] = None, num_meta_parameters: Optional[int] = None, clean: bool = True, finish_missing: bool = False)

TODO describe function

Parameters:

• parameter_grid (ParameterGrid) –

• out_file (str) –

• import_line (str) –

• simulation_config (SimulationConfig) –

• gather_config (Optional[GatherConfig]) –

• num_meta_parameters (Optional[int]) –

• clean (bool) –

Returns:

classmethod from_yaml(file_name: str) → SimulationBuilder

Create a simulation setup from a yaml file.