libpyvinyl.Instrument
- class libpyvinyl.Instrument(name, calculators=None, instrument_base_dir='./')[source]
- Class:
Class collecting the parameters and calculators representing an entire instrument at a facility
Instrument object initialization:
- Parameters:
name (
str
) – The name of this instrumentcalculators (
Optional
[Dict
[str
,BaseCalculator
]]) – a collection of Calculator objects.
- __init__(name, calculators=None, instrument_base_dir='./')[source]
Instrument object initialization:
- Parameters:
name (
str
) – The name of this instrumentcalculators (
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.
Print the list of all defined calculators for this instrument
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
The list of calculators.
Return the master parameters
The name of this instrument.
Return the output of the last calculator
The parameter collection of each calculator in the instrument.