mesoscopy.instrument.source

functions related to current and voltage sources currently integrate only SRS CS580

Classes

CS580(*args, **kwargs)

Stanford CS580 Current source driver

class mesoscopy.instrument.source.CS580(*args: Any, **kwargs: Any)

Bases: VisaInstrument

Stanford CS580 Current source driver

get_idn() → Dict[str, str | None]

Return the Instrument Identifier Message

get_overload() → str

Reads the current avlue of the signal overload status.

add_function(name: str, **kwargs: Any) → None

Bind one Function to this instrument.

Instrument subclasses can call this repeatedly in their __init__ for every real function of the instrument.

This functionality is meant for simple cases, principally things that map to simple commands like *RST (reset) or those with just a few arguments. It requires a fixed argument count, and positional args only. If your case is more complicated, you’re probably better off simply making a new method in your Instrument subclass definition.

Args:

name: How the Function will be stored within

instrument.Functions and also how you address it using the shortcut methods: instrument.call(func_name, *args) etc.

**kwargs: constructor kwargs for Function

Raises:

KeyError: If this instrument already has a function with this

name.

add_parameter(name: str, parameter_class: type = <class 'qcodes.instrument.parameter.Parameter'>, **kwargs: ~typing.Any) → None

Bind one Parameter to this instrument.

Instrument subclasses can call this repeatedly in their __init__ for every real parameter of the instrument.

In this sense, parameters are the state variables of the instrument, anything the user can set and/or get.

Args:

name: How the parameter will be stored within

instrument.parameters and also how you address it using the shortcut methods: instrument.set(param_name, value) etc.

parameter_class: You can construct the parameter

out of any class. Default parameter.Parameter.

**kwargs: Constructor arguments for parameter_class.

Raises:

KeyError: If this instrument already has a parameter with this

name and the parameter being replaced is not an abstract parameter.

ValueError: If there is an existing abstract parameter and the

unit of the new parameter is inconsistent with the existing one.

add_submodule(name: str, submodule: InstrumentModule | ChannelTuple) → None

Bind one submodule to this instrument.

Instrument subclasses can call this repeatedly in their __init__ method for every submodule of the instrument.

Submodules can effectively be considered as instruments within the main instrument, and should at minimum be snapshottable. For example, they can be used to either store logical groupings of parameters, which may or may not be repeated, or channel lists. They should either be an instance of an InstrumentModule or a ChannelTuple.

Args:

name: How the submodule will be stored within

instrument.submodules and also how it can be addressed.

submodule: The submodule to be stored.

Raises:

KeyError: If this instrument already contains a submodule with this

name.

TypeError: If the submodule that we are trying to add is

not an instance of an Metadatable object.

property ancestors: List[InstrumentBase]

Returns a list of instruments, starting from the current instrument and following to the parent instrument and the parents parent instrument until the root instrument is reached.

ask(cmd: str) → str

Write a command string to the hardware and return a response.

Subclasses that transform cmd should override this method, and in it call super().ask(new_cmd). Subclasses that define a new hardware communication should instead override ask_raw.

Args:

cmd: The string to send to the instrument.

Returns:

response

Raises:

Exception: Wraps any underlying exception with extra context,

including the command and the instrument.

ask_raw(cmd: str) → str

Low-level interface to visa_handle.ask.

Args:

cmd: The command to send to the instrument.

Returns:

str: The instrument’s response.

call(func_name: str, *args: Any) → Any

Shortcut for calling a function from its name.

Args:

func_name: The name of a function of this instrument. *args: any arguments to the function.

Returns:

The return value of the function.

check_error(ret_code: int) → None

Default error checking, raises an error if return code !=0. Does not differentiate between warnings or specific error messages. Override this function in your driver if you want to add specific error messages.

Args:

ret_code: A Visa error code. See eg:

https://github.com/hgrecco/pyvisa/blob/master/pyvisa/errors.py

Raises:

visa.VisaIOError: if ret_code indicates a communication

problem.

close() → None

Disconnect and irreversibly tear down the instrument.

classmethod close_all() → None

Try to close all instruments registered in _all_instruments This is handy for use with atexit to ensure that all instruments are closed when a python session is closed.

Examples:

>>> atexit.register(qc.Instrument.close_all())

connect_message(idn_param: str = 'IDN', begin_time: float | None = None) → None

Print a standard message on initial connection to an instrument.

Args:

idn_param: Name of parameter that returns ID dict.

Default IDN.

begin_time: time.time() when init started.

Default is self._t0, set at start of Instrument.__init__.

delegate_attr_dicts: List[str] = ['parameters', 'functions', 'submodules']

A list of names (strings) of dictionaries which are (or will be) attributes of self, whose keys should be treated as attributes of self.

delegate_attr_objects: List[str] = []

A list of names (strings) of objects which are (or will be) attributes of self, whose attributes should be passed through to self.

device_clear() → None

Clear the buffers of the device

static exist(name: str, instrument_class: type | None = None) → bool

Check if an instrument with a given names exists (i.e. is already instantiated).

Args:

name: Name of the instrument. instrument_class: The type of instrument you are looking for.

classmethod find_instrument(name: str, instrument_class: Type[T] | None = None) → T

Find an existing instrument by name.

Args:

name: Name of the instrument. instrument_class: The type of instrument you are looking for.

Returns:

The instrument found.

Raises:

KeyError: If no instrument of that name was found, or if its

reference is invalid (dead).

TypeError: If a specific class was requested but a different

type was found.

property full_name: str

get(param_name: str) → Any

Shortcut for getting a parameter from its name.

Args:

param_name: The name of a parameter of this instrument.

Returns:

The current value of the parameter.

classmethod instances() → List[Instrument]

Get all currently defined instances of this instrument class.

You can use this to get the objects back if you lose track of them, and it’s also used by the test system to find objects to test against.

Returns:

A list of instances.

invalidate_cache() → None

Invalidate the cache of all parameters on the instrument. Calling this method will recursively mark the cache of all parameters on the instrument and any parameter on instrument modules as invalid.

This is useful if you have performed manual operations (e.g. using the frontpanel) which changes the state of the instrument outside QCoDeS.

This in turn means that the next snapshot of the instrument will trigger a (potentially slow) reread of all parameters of the instrument if you pass update=None to snapshot.

static is_valid(instr_instance: Instrument) → bool

Check if a given instance of an instrument is valid: if an instrument has been closed, its instance is not longer a “valid” instrument.

Args:

instr_instance: Instance of an Instrument class or its subclass.

load_metadata(metadata: Mapping[str, Any]) → None

Load metadata into this classes metadata dictionary.

Args:

metadata: Metadata to load.

property name: str

Name of the instrument This is equivalent to full_name for backwards compatibility.

property name_parts: List[str]

omit_delegate_attrs: List[str] = []

A list of attribute names (strings) to not delegate to any other dictionary or object.

property parent: InstrumentBase | None

Returns the parent instrument. By default this is None. Any SubInstrument should subclass this to return the parent instrument.

print_readable_snapshot(update: bool = False, max_chars: int = 80) → None

Prints a readable version of the snapshot. The readable snapshot includes the name, value and unit of each parameter. A convenience function to quickly get an overview of the status of an instrument.

Args:

update: If True, update the state by querying the

instrument. If False, just use the latest values in memory. This argument gets passed to the snapshot function.

max_chars: the maximum number of characters per line. The

readable snapshot will be cropped if this value is exceeded. Defaults to 80 to be consistent with default terminal width.

classmethod record_instance(instance: Instrument) → None

Record (a weak ref to) an instance in a class’s instance list.

Also records the instance in list of all instruments, and verifies that there are no other instruments with the same name.

This method is called after initialization of the instrument is completed.

Args:

instance: Instance to record.

Raises:

KeyError: If another instance with the same name is already present.

classmethod remove_instance(instance: Instrument) → None

Remove a particular instance from the record.

Args:

instance: The instance to remove

property root_instrument: InstrumentBase

set(param_name: str, value: Any) → None

Shortcut for setting a parameter from its name and new value.

Args:

param_name: The name of a parameter of this instrument. value: The new value to set.

set_address(address: str) → None

Set the address for this instrument.

Args:

address: The visa resource name to use to connect. The address

should be the actual address and just that. If you wish to change the backend for VISA, use the self.visalib attribute (and then call this function).

set_terminator(terminator: str | None) → None

Change the read terminator to use.

Args:

terminator: Character(s) to look for at the end of a read and

to end each write command with. eg. \r\n. If None the terminator will not be set.

shared_kwargs = ()

property short_name: str

Short name of the instrument

snapshot(update: bool | None = False) → Dict[Any, Any]

Decorate a snapshot dictionary with metadata. DO NOT override this method if you want metadata in the snapshot instead, override snapshot_base().

Args:

update: Passed to snapshot_base.

Returns:

Base snapshot.

snapshot_base(update: bool | None = True, params_to_skip_update: Sequence[str] | None = None) → Dict[Any, Any]

State of the instrument as a JSON-compatible dict (everything that the custom JSON encoder class qcodes.utils.helpers.NumpyJSONEncoder supports).

Args:

update: If True, update the state by querying the

instrument. If None only update if the state is known to be invalid. If False, just use the latest values in memory and never update.

params_to_skip_update: List of parameter names that will be skipped

in update even if update is True. This is useful if you have parameters that are slow to update but can be updated in a different way (as in the qdac). If you want to skip the update of certain parameters in all snapshots, use the snapshot_get attribute of those parameters instead.

Returns:

dict: base snapshot

validate_status(verbose: bool = False) → None

Validate the values of all gettable parameters

The validation is done for all parameters that have both a get and set method.

Arguments:

verbose: If True, then information about the

parameters that are being check is printed.

write(cmd: str) → None

Write a command string with NO response to the hardware.

Subclasses that transform cmd should override this method, and in it call super().write(new_cmd). Subclasses that define a new hardware communication should instead override write_raw.

Args:

cmd: The string to send to the instrument.

Raises:

Exception: Wraps any underlying exception with extra context,

including the command and the instrument.

write_raw(cmd: str) → None

Low-level interface to visa_handle.write.

Args:

cmd: The command to send to the instrument.

parameters: Dict[str, _BaseParameter]

All the parameters supported by this instrument. Usually populated via add_parameter().

functions: Dict[str, Function]

All the functions supported by this instrument. Usually populated via add_function().

submodules: Dict[str, 'InstrumentModule' | 'ChannelTuple']

All the submodules of this instrument such as channel lists or logical groupings of parameters. Usually populated via add_submodule().

instrument_modules: Dict[str, 'InstrumentModule']

All the instrument_modules of this instrument Usually populated via add_submodule().