API reference

• quantify_core.analysis
  • base_analysis
    • AnalysisMeta
    • AnalysisSteps
    • BaseAnalysis
      • BaseAnalysis.analysis_steps
      • BaseAnalysis.__init__()
      • BaseAnalysis._get_analysis_dir()
      • BaseAnalysis._get_results_dir()
      • BaseAnalysis._repr_html_()
      • BaseAnalysis.adjust_clim()
      • BaseAnalysis.adjust_cmap()
      • BaseAnalysis.adjust_figures()
      • BaseAnalysis.adjust_xlim()
      • BaseAnalysis.adjust_ylim()
      • BaseAnalysis.analyze_fit_results()
      • BaseAnalysis.create_figures()
      • BaseAnalysis.display_figs_mpl()
      • BaseAnalysis.execute_analysis_steps()
      • BaseAnalysis.extract_data()
      • BaseAnalysis.get_flow()
      • BaseAnalysis.load_fit_result()
      • BaseAnalysis.process_data()
      • BaseAnalysis.run()
      • BaseAnalysis.run_fitting()
      • BaseAnalysis.save_figures()
      • BaseAnalysis.save_figures_mpl()
      • BaseAnalysis.save_fit_results()
      • BaseAnalysis.save_processed_dataset()
      • BaseAnalysis.save_quantities_of_interest()
      • BaseAnalysis.analysis_dir
      • BaseAnalysis.name
      • BaseAnalysis.results_dir
    • Basic1DAnalysis
      • Basic1DAnalysis.run()
    • Basic2DAnalysis
      • Basic2DAnalysis.create_figures()
    • BasicAnalysis
      • BasicAnalysis.create_figures()
    • _FiguresMplCache
    • analysis_steps_to_str()
    • check_lmfit()
    • flatten_lmfit_modelresult()
    • lmfit_par_to_ufloat()
    • wrap_text()
    • settings
  • cosine_analysis
    • CosineAnalysis
      • CosineAnalysis.analyze_fit_results()
      • CosineAnalysis.create_figures()
      • CosineAnalysis.process_data()
      • CosineAnalysis.run_fitting()
  • spectroscopy_analysis
    • QubitFluxSpectroscopyAnalysis
      • QubitFluxSpectroscopyAnalysis.analyze_fit_results()
      • QubitFluxSpectroscopyAnalysis.create_figures()
      • QubitFluxSpectroscopyAnalysis.process_data()
      • QubitFluxSpectroscopyAnalysis.run_fitting()
    • QubitSpectroscopyAnalysis
      • QubitSpectroscopyAnalysis.analyze_fit_results()
      • QubitSpectroscopyAnalysis.create_figures()
      • QubitSpectroscopyAnalysis.process_data()
      • QubitSpectroscopyAnalysis.run_fitting()
    • ResonatorFluxSpectroscopyAnalysis
      • ResonatorFluxSpectroscopyAnalysis.analyze_fit_results()
      • ResonatorFluxSpectroscopyAnalysis.create_figures()
      • ResonatorFluxSpectroscopyAnalysis.process_data()
      • ResonatorFluxSpectroscopyAnalysis.run_fitting()
    • ResonatorSpectroscopyAnalysis
      • ResonatorSpectroscopyAnalysis.analyze_fit_results()
      • ResonatorSpectroscopyAnalysis.create_figures()
      • ResonatorSpectroscopyAnalysis.process_data()
      • ResonatorSpectroscopyAnalysis.run_fitting()
  • single_qubit_timedomain
    • AllXYAnalysis
      • AllXYAnalysis.create_figures()
      • AllXYAnalysis.process_data()
      • AllXYAnalysis.run()
    • EchoAnalysis
      • EchoAnalysis.analyze_fit_results()
      • EchoAnalysis.create_figures()
      • EchoAnalysis.run_fitting()
    • RabiAnalysis
      • RabiAnalysis._rotate_to_calibrated_axis()
      • RabiAnalysis.analyze_fit_results()
      • RabiAnalysis.create_figures()
      • RabiAnalysis.run()
      • RabiAnalysis.run_fitting()
    • RamseyAnalysis
      • RamseyAnalysis.analyze_fit_results()
      • RamseyAnalysis.create_figures()
      • RamseyAnalysis.run()
      • RamseyAnalysis.run_fitting()
    • SingleQubitTimedomainAnalysis
      • SingleQubitTimedomainAnalysis.process_data()
      • SingleQubitTimedomainAnalysis.run()
    • T1Analysis
      • T1Analysis.analyze_fit_results()
      • T1Analysis.create_figures()
      • T1Analysis.run_fitting()
    • _DecayFigMixin
      • _DecayFigMixin._create_decay_figure()
  • interpolation_analysis
    • InterpolationAnalysis2D
      • InterpolationAnalysis2D.create_figures()
  • optimization_analysis
    • OptimizationAnalysis
      • OptimizationAnalysis.create_figures()
      • OptimizationAnalysis.process_data()
      • OptimizationAnalysis.run()
    • iteration_plots()
  • fitting_models
    • CosineModel
      • CosineModel.__init__()
      • CosineModel.guess()
    • DecayOscillationModel
      • DecayOscillationModel.__init__()
      • DecayOscillationModel.guess()
    • ExpDecayModel
      • ExpDecayModel.__init__()
      • ExpDecayModel.guess()
    • LorentzianModel
      • LorentzianModel.guess()
    • RabiModel
      • RabiModel.__init__()
      • RabiModel.guess()
    • ResonatorModel
      • ResonatorModel.__init__()
      • ResonatorModel.guess()
    • cos_func()
    • exp_damp_osc_func()
    • exp_decay_func()
    • fft_freq_phase_guess()
    • get_guess_common_doc()
    • get_model_common_doc()
    • hanger_func_complex_SI()
    • lorentzian_func()
    • mk_seealso()
    • resonator_phase_guess()
  • calibration
    • has_calibration_points()
    • rotate_to_calibrated_axis()
  • readout_calibration_analysis
    • ReadoutCalibrationAnalysis
      • ReadoutCalibrationAnalysis.analyze_fit_results()
      • ReadoutCalibrationAnalysis.create_figures()
      • ReadoutCalibrationAnalysis.process_data()
      • ReadoutCalibrationAnalysis.run_fitting()
  • conditional_oscillation_analysis
    • ConditionalOscillationAnalysis
      • ConditionalOscillationAnalysis.analyze_fit_results()
      • ConditionalOscillationAnalysis.create_figures()
      • ConditionalOscillationAnalysis.process_data()
      • ConditionalOscillationAnalysis.run_fitting()
• quantify_core.data
  • types
    • TUID
      • TUID.datetime()
      • TUID.datetime_seconds()
      • TUID.is_valid()
      • TUID.uuid()
  • handling
    • DecodeToNumpy
      • DecodeToNumpy.__init__()
      • DecodeToNumpy._object_hook()
    • _generate_long_name()
    • _generate_name()
    • _instrument_submodules_settable()
    • _is_batched()
    • _is_uniformly_spaced_array()
    • _vars_match()
    • _xarray_numpy_bool_patch()
    • _xi_and_yi_match()
    • concat_dataset()
    • create_exp_folder()
    • default_datadir()
    • extract_parameter_from_snapshot()
    • gen_tuid()
    • get_datadir()
    • get_latest_tuid()
    • get_tuids_containing()
    • get_varying_parameter_values()
    • grow_dataset()
    • initialize_dataset()
    • load_dataset()
    • load_dataset_from_path()
    • load_processed_dataset()
    • load_quantities_of_interest()
    • load_snapshot()
    • locate_experiment_container()
    • multi_experiment_data_extractor()
    • set_datadir()
    • snapshot()
    • to_gridded_dataset()
    • trim_dataset()
    • write_dataset()
  • dataset_adapters
    • AdapterH5NetCDF
      • AdapterH5NetCDF.adapt()
      • AdapterH5NetCDF.attrs_convert()
      • AdapterH5NetCDF.recover()
    • DatasetAdapterBase
      • DatasetAdapterBase.adapt()
      • DatasetAdapterBase.recover()
    • DatasetAdapterIdentity
      • DatasetAdapterIdentity.adapt()
      • DatasetAdapterIdentity.recover()
  • dataset_attrs
    • QCoordAttrs
      • QCoordAttrs.is_dataset_ref
      • QCoordAttrs.is_main_coord
      • QCoordAttrs.json_serialize_exclude
      • QCoordAttrs.long_name
      • QCoordAttrs.uniformly_spaced
      • QCoordAttrs.unit
    • QDatasetAttrs
      • QDatasetAttrs.dataset_name
      • QDatasetAttrs.dataset_state
      • QDatasetAttrs.json_serialize_exclude
      • QDatasetAttrs.quantify_dataset_version
      • QDatasetAttrs.relationships
      • QDatasetAttrs.software_versions
      • QDatasetAttrs.timestamp_end
      • QDatasetAttrs.timestamp_start
      • QDatasetAttrs.tuid
    • QDatasetIntraRelationship
      • QDatasetIntraRelationship.item_name
      • QDatasetIntraRelationship.related_names
      • QDatasetIntraRelationship.relation_metadata
      • QDatasetIntraRelationship.relation_type
    • QVarAttrs
      • QVarAttrs.grid
      • QVarAttrs.has_repetitions
      • QVarAttrs.is_dataset_ref
      • QVarAttrs.is_main_var
      • QVarAttrs.json_serialize_exclude
      • QVarAttrs.long_name
      • QVarAttrs.uniformly_spaced
      • QVarAttrs.unit
    • _get_all_variables()
    • _get_dims()
    • get_main_coords()
    • get_main_dims()
    • get_main_vars()
    • get_secondary_coords()
    • get_secondary_dims()
    • get_secondary_vars()
  • experiment
    • QuantifyExperiment
      • QuantifyExperiment.__init__()
      • QuantifyExperiment._get_or_create_experiment_directory()
      • QuantifyExperiment.load_dataset()
      • QuantifyExperiment.load_metadata()
      • QuantifyExperiment.load_snapshot()
      • QuantifyExperiment.load_text()
      • QuantifyExperiment.save_metadata()
      • QuantifyExperiment.save_snapshot()
      • QuantifyExperiment.save_text()
      • QuantifyExperiment.write_dataset()
      • QuantifyExperiment.experiment_directory
      • QuantifyExperiment.experiment_name
• quantify_core.measurement
  • types
    • Gettable
    • Settable
    • is_batched()
    • is_object_or_function()
  • control
    • MeasurementControl
      • MeasurementControl._curr_setpoint_idx()
      • MeasurementControl._finish()
      • MeasurementControl._get_fracdone()
      • MeasurementControl._get_max_setpoints()
      • MeasurementControl._init()
      • MeasurementControl._iterative_set_and_get()
      • MeasurementControl._prepare_gettables()
      • MeasurementControl._prepare_settables()
      • MeasurementControl._process_acquired_data()
      • MeasurementControl._reset()
      • MeasurementControl._reset_post()
      • MeasurementControl._reshape_data()
      • MeasurementControl._safe_write_dataset()
      • MeasurementControl._update()
      • MeasurementControl.clear_experiment_data()
      • MeasurementControl.get_idn()
      • MeasurementControl.gettables()
      • MeasurementControl.measurement_description()
      • MeasurementControl.print_progress()
      • MeasurementControl.run()
      • MeasurementControl.run_adaptive()
      • MeasurementControl.set_experiment_data()
      • MeasurementControl.setpoints()
      • MeasurementControl.setpoints_grid()
      • MeasurementControl.settables()
      • MeasurementControl.show()
      • MeasurementControl._gettable_pars
      • MeasurementControl._setpoints
      • MeasurementControl._setpoints_input
      • MeasurementControl._settable_pars
      • MeasurementControl.instr_plotmon
      • MeasurementControl.lazy_set
      • MeasurementControl.metadata_compression
      • MeasurementControl.on_progress_callback
      • MeasurementControl.update_interval
      • MeasurementControl.verbose
    • _KeyboardInterruptManager
      • _KeyboardInterruptManager.raise_if_interrupted()
    • _SupportsMul
    • grid_setpoints()
• quantify_core.utilities
  • experiment_helpers
    • compare_snapshots()
    • create_plotmon_from_historical()
    • get_all_parents()
    • load_settings_onto_instrument()
  • dataset_examples
    • mk_2d_dataset_v1()
    • mk_nested_mc_dataset()
    • mk_shots_from_probabilities()
    • mk_surface7_cyles_dataset()
    • mk_t1_av_dataset()
    • mk_t1_av_with_cal_dataset()
    • mk_t1_shots_dataset()
    • mk_t1_traces_dataset()
    • mk_two_qubit_chevron_data()
    • mk_two_qubit_chevron_dataset()
  • examples_support
    • mk_cosine_instrument()
    • mk_dataset_attrs()
    • mk_iq_shots()
    • mk_main_coord_attrs()
    • mk_main_var_attrs()
    • mk_secondary_coord_attrs()
    • mk_secondary_var_attrs()
    • mk_trace_for_iq_shot()
    • mk_trace_time()
    • round_trip_dataset()
  • deprecation
    • _find_stack_level()
    • deprecated()
• quantify_core.visualization
  • instrument_monitor
    • InstrumentMonitor
      • InstrumentMonitor._update()
      • InstrumentMonitor.close()
      • InstrumentMonitor.create_widget()
      • InstrumentMonitor.setGeometry()
      • InstrumentMonitor.update_interval
      • InstrumentMonitor.update_snapshot
    • RepeatTimer
      • RepeatTimer.cancel()
      • RepeatTimer.pause()
      • RepeatTimer.run()
      • RepeatTimer.unpause()
  • pyqt_plotmon
    • PlotMonitor_pyqt
      • PlotMonitor_pyqt.__init__()
      • PlotMonitor_pyqt.close()
      • PlotMonitor_pyqt.create_plot_monitor()
      • PlotMonitor_pyqt.setGeometry_main()
      • PlotMonitor_pyqt.setGeometry_secondary()
      • PlotMonitor_pyqt.tuids_append()
      • PlotMonitor_pyqt.update()
      • PlotMonitor_pyqt.main_QtPlot
      • PlotMonitor_pyqt.secondary_QtPlot
      • PlotMonitor_pyqt.tuids
      • PlotMonitor_pyqt.tuids_extra
      • PlotMonitor_pyqt.tuids_max_num
    • QtPlotObjForJupyter
  • color_utilities
    • set_hlsa()
  • mpl_plotting
    • flex_colormesh_plot_vs_xy()
    • get_unit_from_attrs()
    • plot_2d_grid()
    • plot_complex_points()
    • plot_fit()
    • plot_fit_complex_plane()
    • plot_textbox()
    • plot_xr_complex()
    • plot_xr_complex_on_plane()
    • set_cyclic_colormap()
    • set_suptitle_from_dataset()
  • plot_interpolation
    • interpolate_heatmap()
  • SI_utilities
    • SafeFormatter
    • SI_prefix_and_scale_factor()
    • SI_val_to_msg_str()
    • _get_scale_factor_and_offset_and_prefix()
    • _set_offset_string()
    • adjust_axeslabels_SI()
    • format_value_string()
    • set_cbarlabel()
    • set_xlabel()
    • set_ylabel()
    • value_precision()