QCoDes API documentation

This page documents the QCoDes API. This page contains documentation of all user facing modules.

QCoDeS API

• qcodes.calibrations
  • calibrate_keithley_smu_v()
• qcodes.configuration
  • Config
  • DotDict
  • qcodes default configuration
• qcodes.dataset
  • AbstractSweep
  • ArraySweep
  • BreakConditionInterrupt
  • ConnectionPlus
  • DataSetProtocol
  • DataSetType
  • InterDependencies_
  • LinSweep
  • LogSweep
  • Measurement
  • ParamSpec
  • RunDescriber
  • SQLiteSettings
  • SequentialParamsCaller
  • ThreadPoolParamsCaller
  • TogetherSweep
  • call_params_threaded()
  • connect()
  • datasaver_builder()
  • DataSetDefinition
  • do0d()
  • do1d()
  • do2d()
  • dond()
  • dond_into()
  • experiments()
  • extract_runs_into_db()
  • get_data_export_path()
  • get_default_experiment_id()
  • get_guids_by_run_spec()
  • guids_from_dbs()
  • guids_from_dir()
  • guids_from_list_str()
  • import_dat_file()
  • initialise_database()
  • initialise_or_create_database_at()
  • initialised_database_at()
  • LinSweeper
  • load_by_counter()
  • load_by_guid()
  • load_by_id()
  • load_by_run_spec()
  • load_experiment()
  • load_experiment_by_name()
  • load_from_file()
  • load_from_netcdf()
  • load_last_experiment()
  • load_or_create_experiment()
  • new_data_set()
  • new_experiment()
  • plot_by_id()
  • plot_dataset()
  • reset_default_experiment_id()
  • rundescriber_from_json()
• qcodes.extensions
  • register_station_schema_with_vscode()
  • log_dataset_export_info()
  • DriverTestCase
  • InferAttrs
  • InferError
  • get_chain_links_of_type()
  • get_instrument_from_param()
  • get_parameter_chain()
  • get_root_parameter()
  • get_sole_chain_link_of_type()
  • get_parent_instruments_from_chain_of_type()
  • get_sole_parent_instrument_from_chain_of_type()
  • infer_channel()
  • infer_instrument()
  • infer_instrument_module()
• qcodes.instrument
  • ChannelList
  • ChannelTuple
  • IPInstrument
  • Instrument
  • InstrumentBase
  • InstrumentBaseKWArgs
  • InstrumentChannel
  • InstrumentModule
  • VisaInstrument
  • VisaInstrumentKWArgs
  • find_or_create_instrument()
• qcodes.interactive_widget
  • experiments_widget()
  • nested_dict_browser()
• qcodes.logger
  • LogCapture
  • capture_dataframe()
  • console_level()
  • filter_instrument()
  • flush_telemetry_traces()
  • get_console_handler()
  • get_file_handler()
  • get_instrument_logger()
  • get_level_code()
  • get_level_name()
  • get_log_file_name()
  • handler_level()
  • log_to_dataframe()
  • logfile_to_dataframe()
  • start_all_logging()
  • start_command_history_logger()
  • start_logger()
  • time_difference()
• qcodes.math_utils
  • FieldVector
• qcodes.metadatable
  • Metadatable
  • MetadatableWithName
• qcodes.monitor
  • Monitor
• qcodes.parameters
  • ArrayParameter
  • CombinedParameter
  • DelegateGroup
  • DelegateGroupParameter
  • DelegateParameter
  • ElapsedTimeParameter
  • Function
  • Group
  • GroupParameter
  • GroupedParameter
  • InstrumentRefParameter
  • ManualParameter
  • MultiChannelInstrumentParameter
  • MultiParameter
  • ParamDataType
  • ParamRawDataType
  • Parameter
  • ParameterBase
  • ParameterWithSetpoints
  • ScaledParameter
  • SweepFixedValues
  • SweepValues
  • create_on_off_val_mapping()
  • combine()
  • expand_setpoints_helper()
  • invert_val_mapping()
• qcodes.plotting
  • apply_auto_color_scale()
  • apply_color_scale_limits()
  • auto_color_scale_from_config()
  • auto_range_iqr()
  • find_scale_and_prefix()
• qcodes.station
  • get_config_enable_forced_reconnect()
  • get_config_default_folder()
  • get_config_default_file()
  • get_config_use_monitor()
  • ValidationWarning
  • StationConfig
  • Station
  • update_config_schema()
• qcodes.utils
  • DelayedKeyboardInterrupt
  • DelegateAttributes
  • NumpyJSONEncoder
  • ParameterDiff
  • QCoDeSDeprecationWarning
  • RespondingThread
  • attribute_set_to()
  • checked_getattr()
  • getattr_indexed()
  • checked_getattr_indexed()
  • convert_legacy_version_to_supported_version()
  • deep_update()
  • deprecate()
  • diff_param_values()
  • extract_param_values()
  • full_class()
  • get_all_installed_package_versions()
  • get_qcodes_path()
  • get_qcodes_user_path()
  • is_function()
  • is_qcodes_installed_editably()
  • issue_deprecation_warning()
  • list_of_data_to_maybe_ragged_nd_array()
  • partial_with_docstring()
  • qcodes_abstractmethod()
  • strip_attrs()
  • thread_map()
• qcodes.validators
  • Anything
  • Arrays
  • Bool
  • Callable
  • ComplexNumbers
  • Dict
  • Enum
  • Ints
  • Lists
  • Multiples
  • MultiType
  • MultiTypeAnd
  • MultiTypeOr
  • Nothing
  • Numbers
  • OnOff
  • PermissiveInts
  • PermissiveMultiples
  • Sequence
  • Strings
  • Validator
  • validate_all()