Monitors

class batsim_py.monitors.ConsumedEnergyMonitor(simulator)[source]

Simulator Energy Monitor class.

This monitor collects energy statistics.

Parameters

simulator (SimulatorHandler) – The simulator handler.

Raises

RuntimeError – In case of simulation is already running.

property info

Get all the collected statistics.

Return type

dict

Returns

A dict containing statistics.

to_csv(fn)[source]

Dump info to a CSV file.

Return type

None

to_dataframe()[source]

Convert info into a DataFrame.

Return type

DataFrame

class batsim_py.monitors.EnergyEventType(value)[source]

Energy event types used in the ConsumedEnergyMonitor.

class batsim_py.monitors.HostMonitor(simulator)[source]

Simulator Host Monitor class.

This monitor collects statistics about the time each host spent on each of its possible states. Moreover, it computes the total energy consumed and the total number of host state switches.

Parameters

simulator (SimulatorHandler) – The simulator handler.

Raises

RuntimeError – In case of simulation is already running.

property info

Get all the collected statistics.

Return type

dict

Returns

A dict containing statistics.

to_csv(fn)[source]

Dump info to a CSV file.

Return type

None

to_dataframe()[source]

Convert info into a DataFrame.

Return type

DataFrame

class batsim_py.monitors.HostPowerStateSwitchMonitor(simulator)[source]

Simulator Host Power State Monitor class.

This monitor collects statistics about host power state switches.

Parameters

simulator (SimulatorHandler) – The simulator handler.

Raises

RuntimeError – In case of simulation is already running.

property info

Get all the collected statistics.

Return type

dict

Returns

A dict containing statistics.

to_csv(fn)[source]

Dump info to a CSV file.

Return type

None

to_dataframe()[source]

Convert info into a DataFrame.

Return type

DataFrame

class batsim_py.monitors.HostStateSwitchMonitor(simulator)[source]

Simulator Host State Monitor class.

This monitor collects statistics about host state switches.

Parameters

simulator (SimulatorHandler) – The simulator handler.

Raises

RuntimeError – In case of simulation is already running.

property info

Get all the collected statistics.

Return type

dict

Returns

A dict containing statistics.

to_csv(fn)[source]

Dump info to a CSV file.

Return type

None

to_dataframe()[source]

Convert info into a DataFrame.

Return type

DataFrame

class batsim_py.monitors.JobMonitor(simulator)[source]

Simulator Job Monitor class.

This monitor collects statistics about each submitted job.

Parameters

simulator (SimulatorHandler) – The simulator handler.

Raises

RuntimeError – In case of simulation is already running.

property info

Get all the collected statistics.

Return type

dict

Returns

A dict containing statistics.

to_csv(fn)[source]

Dump info to a CSV file.

Return type

None

to_dataframe()[source]

Convert info into a DataFrame.

Return type

DataFrame

class batsim_py.monitors.Monitor(simulator)[source]

Simulation Monitor base class.

Parameters

simulator (SimulatorHandler) – The simulator handler.

Raises

RuntimeError – In case of simulation is already running.

abstract property info

Get all the collected statistics.

Return type

dict

Returns

A dict containing statistics.

abstract to_csv(fn)[source]

Dump info to a CSV file.

Return type

None

abstract to_dataframe()[source]

Convert info into a DataFrame.

Return type

DataFrame

class batsim_py.monitors.SchedulerMonitor(simulator)[source]

Simulator Scheduler Monitor class.

This monitor collects statistics about scheduler performance.

Parameters

simulator (SimulatorHandler) – The simulator handler.

Raises

RuntimeError – In case of simulation is already running.

property info

Get all the collected statistics.

Return type

dict

Returns

A dict containing statistics.

to_csv(fn)[source]

Dump info to a CSV file.

Return type

None

to_dataframe()[source]

Convert info into a DataFrame.

Return type

DataFrame

class batsim_py.monitors.SimulationMonitor(simulator)[source]

Simulator Monitor class.

This monitor collects statistics about the simulation, which includes statistics about the scheduler performance and about each job.

Parameters

simulator (SimulatorHandler) – The simulator handler.

Raises

RuntimeError – In case of simulation is already running.

property info

Get all the collected statistics.

Return type

dict

Returns

A dict containing statistics.

to_csv(fn)[source]

Dump info to a CSV file.

Return type

None

to_dataframe()[source]

Convert info into a DataFrame.

Return type

DataFrame