Welcome to QuMADA’s documentation!

Contents:

• 1. Installation
  • 1.1. Setup virtual environment
  • 1.2. Setup for general use
  • 1.3. Setup for development
  • 1.4. Build documentation
• 2. Tutorials
  • 2.1. First steps: Example Measurements
    • 2.1.1. Station and Instruments
    • 2.1.2. Metadata (Optional, WIP)
    • 2.1.3. Specifying the database for storing the data
    • 2.1.4. Terminal parameters
    • 2.1.5. Measurement Scripts
    • 2.1.6. Mapping terminals to instruments
    • 2.1.7. Save and load mapped terminal parameters
    • 2.1.8. Run the measurement
    • 2.1.9. Accessing Measurent Data and Plotting the Measurement
    • 2.1.10. 2nd Measurement: 1D-Sweeps
    • 2.1.11. 3rd Measurement: 2D-Sweep
  • 2.2. Adding the QuMADA Buffer Class to Instruments (WIP)
    • Buffer
    • num_points()
    • subscribe()
  • 2.3. Sensor Compensation
• 3. Device Object
  • 3.1. Creating a Device
    • 3.1.1. Creating from parameters dictionary
    • 3.1.2. Updating an existing device
  • 3.2. Mapping
  • 3.3. Using the device
    • 3.3.1. Setting and Getting Parameters
    • 3.3.2. Simple Measurements
    • 3.3.3. Storing and Loading Setpoints
    • 3.3.4. Buffered Measurements
    • 3.3.5. Sensor Compensation
    • 3.3.6. Safety features (WIP)
• 4. Measurement Scripts
  • 4.1. Generic_1D_Sweep()
    • Generic_1D_Sweep
  • 4.2. Generic_1D_parallel_Sweep()
    • Generic_1D_parallel_Sweep
  • 4.3. Generic_nD_Sweep
    • Generic_nD_Sweep
  • 4.4. Timetrace
    • Timetrace
  • 4.5. Timetrace with Sweeps (buffered)
  • 4.6. Pulsed Measurements (buffered)
  • 4.7. Generic_Pulsed_Repeated_Measurement
  • 4.8. 1D Hysteresis Sweeps (buffered)
  • 4.9. 2D Sweeps buffered
  • 4.10. Writing your own measurement scripts (WIP)
  • 4.11. Working with gate_parameters
• 5. Buffered Measurements
• 6. Mapping GUI
• 7. Other
  • 7.1. Plotting with QuMada
• 8. Working with metadata
  • 8.1. Automatically collecting metadata
  • 8.2. Save to database
• 9. QuMADA API Documentation
  • 9.1. qumada._version
    • get_version()
  • 9.2. qumada.instrument
    • 9.2.1. qumada.instrument.buffered_instruments
    • 9.2.2. qumada.instrument.buffers
    • 9.2.3. qumada.instrument.custom_drivers
    • 9.2.4. qumada.instrument.instrument
    • 9.2.5. qumada.instrument.mapping
    • 9.2.6. qumada.instrument.sims
  • 9.3. qumada.measurement
    • 9.3.1. qumada.measurement.device_object
    • 9.3.2. qumada.measurement.jobs
    • 9.3.3. qumada.measurement.measurement
    • 9.3.4. qumada.measurement.scripts
  • 9.4. qumada.metadata
    • BasicMetadata
    • Metadata
    • Savable
  • 9.5. qumada.utils
    • 9.5.1. qumada.utils.GUI
    • 9.5.2. qumada.utils.browsefiles
    • 9.5.3. qumada.utils.device_GUI
    • 9.5.4. qumada.utils.generate_sweeps
    • 9.5.5. qumada.utils.import_submodules
    • 9.5.6. qumada.utils.init_station
    • 9.5.7. qumada.utils.load_from_sqlite_db
    • 9.5.8. qumada.utils.load_save_config
    • 9.5.9. qumada.utils.parameter_file_helpers
    • 9.5.10. qumada.utils.plotting
    • 9.5.11. qumada.utils.ramp_parameter
    • 9.5.12. qumada.utils.resources
    • 9.5.13. qumada.utils.utils

Indices and tables

• Index

• Module Index

• Search Page