libpyvinyl.Instrument

class libpyvinyl.Instrument(name, calculators=None, instrument_base_dir='./')

Class collecting the parameters and calculators representing an entire instrument at a facility

Instrument object initialization:

Parameters:

• name (str) – The name of this instrument

• calculators (Optional[Dict[str, BaseCalculator]]) – a collection of Calculator objects.

__init__(name, calculators=None, instrument_base_dir='./')

Instrument object initialization:

Parameters:

• name (str) – The name of this instrument

• calculators (Optional[Dict[str, BaseCalculator]]) – a collection of Calculator objects.

Methods

__init__(name[, calculators, ...])	Instrument object initialization:
add_calculator(calculator)	Append one calculator to the list of calculators.
add_master_parameter(name, links, **kwargs)	Add a new parameter with the given name as master parameter.
list_calculators()	Print the list of all defined calculators for this instrument
list_parameters()	Print the list of all calculator parameters
remove_calculator(calculator_name)	Remove the calculator with the given name from the list of calculators
run()	Run the entire simulation, i.e. all the calculators in the order they have been provided.
set_instrument_base_dir(base)	Set each calculator's instrument_base_dir to 'base.

Attributes

calculators	The list of calculators.
instrument_base_dir
master	Return the master parameters
name	The name of this instrument.
output	Return the output of the last calculator
parameters	The parameter collection of each calculator in the instrument.