libpyvinyl.Instrument.Instrument
libpyvinyl.Instrument.Instrument¶
- class libpyvinyl.Instrument.Instrument(name, calculators=None, instrument_base_dir='./')¶
An Instrument class
- __init__(name, calculators=None, instrument_base_dir='./')¶
An Instrument class
- Parameters
name (str) – The name of this instrument
calculators (dict) – A collection of Calculator objects.
Methods
__init__(name[, calculators, ...])An Instrument class
add_calculator(calculator)add_master_parameter(name, links, **kwargs)list_calculators()list_parameters()remove_calculator(calculator_name)run()set_instrument_base_dir(base)Set each calculator's instrument_base_dir to 'base.
Attributes
The list of calculators.
masterThe name of this instrument.
The parameter collection of each calculator in the instrument.
- property calculators¶
The list of calculators. It’s modified either when constructing the class instance or using the add_calculator function.
- property name¶
The name of this instrument.
- property parameters¶
The parameter collection of each calculator in the instrument. These parameters are links to the exact parameters of each calculator.
- set_instrument_base_dir(base: str)¶
Set each calculator’s instrument_base_dir to ‘base. Each calculator’s data file ouput directory will be “instrument_base_dir/calculator_base_dir”.
- Parameters
base (str) – The base directory to be set.