Welcome to pysmurf’s documentation!

The Python control software for SMuRF (SLAC Microresonator RF). Provides low-level register commands and high-level operations for tuning, tracking, and streaming data from superconducting microresonator arrays.

Note

This documentation corresponds to pysmurf 11.2.0.post1.dev32+ga6677a59a. Install from PyPI: pip install pysmurf-slac

User Guide

• Introduction
  • Hardware Overview
  • Bands, Sub-bands, and Channels
• Concepts
  • Resonator Readout
  • Firmware Signal Chain
  • Eta Calibration
  • Tone Tracking
  • Flux Ramp
  • Data Output Levels
• Installation
  • Requirements
  • Install
  • Offline Mode
• Configuration
  • Config File Location
  • Setup Steps
  • Usage
  • Band Parameters (init.band_#)
  • Bad Mask
  • Constants
  • Paths
  • Other Sections
  • Firmware Defaults
• Quickstart
  • Connect
  • Setup
  • Tune
  • Check Channels
  • Stream Data
  • Noise
  • IV Curves
  • Shutdown
• Operations
  • Tuning
    • find_freq
    • setup_notches
    • eta_scan
    • track_and_check
  • Feedback Control
  • Flux Ramp
  • Streaming
    • Debug Data
    • ADC/DAC
  • TES Bias and IV Curves
  • Amplifier Bias
  • Noise
  • Saving State
• See Also
  • Related Repositories
  • Publications
• Developer Guide
  • Docstrings
  • Building Docs
  • Architecture
  • Testing

Client API

• base module
  • base_class
    • SmurfBase
  • logger
    • Logger
    • SmurfLogger
  • smurf_config
    • SmurfConfig
  • smurf_control
    • SmurfControl
  • smurf_config_properties
    • SmurfConfigPropertiesMixin
• command module
  • cryo_card
  • smurf_atca_monitor
    • SmurfAtcaMonitorMixin
  • smurf_cmd
    • acq_n_frames()
    • cfg_filename
    • get_port()
    • make_runfile()
    • set_port()
    • start_acq()
    • stop_acq()
  • smurf_command
    • SmurfCommandMixin
  • sync_group
• debug module
  • smurf_iv
    • SmurfIVMixin
  • smurf_noise
    • SmurfNoiseMixin
• tune module
  • smurf_tune
    • SmurfTuneMixin
• util module
  • pub
    • Publisher
  • smurf_util
    • SmurfUtilMixin
  • tools
    • P_singleMode()
    • dPdT_singleMode()
    • fit_skewed_lorentzian()
    • limit_phase_deg()
    • load_yaml()
    • save_to_txt()
    • skewed_lorentzian()
    • utf8_to_str()
    • yaml_parse()

Core API

• conventers module
  • _Header2Smurf
    • Header2Smurf
• counters module
  • _FrameStatistics
    • FrameStatistics
• devices module
  • _PcieCard
    • PcieCard
    • PcieDev
  • _SmurfApplication
    • SmurfApplication
  • _SmurfProcessor
    • Downsampler
    • GeneralAnalogFilter
    • SmurfChannelMapper
    • SmurfProcessor
    • Unwrapper
  • _UdpReceiver
    • KeepAlive
    • UdpReceiver
• emulators module
  • _DataFromFile
    • DataFromFile
    • DataMaster
  • _StreamDataEmulatorI16
    • StreamDataEmulatorI16
  • _StreamDataEmulatorI32
    • StreamDataEmulatorI32
  • _StreamDataSource
    • StreamDataSource
• roots module
  • CmbEth
    • CmbEth
  • CmbPcie
    • CmbPcie
  • Common
    • Common
  • DevBoardEth
    • DevBoardEth
  • DevBoardPcie
    • DevBoardPcie
  • EmulationRoot
    • EmulationRoot
• server_scripts module
  • Common
    • get_args()
    • make_parser()
    • process_args()
  • _VariableGroupExample
• transmitters module
  • _BaseTransmitter
    • BaseTransmitter
  • _DataToFile
    • DataSlave
    • DataToFile
    • MetaSlave
• utilities module
  • _SetupGroups
    • setupGroups()
  • _SmurfPublisher
    • SmurfPublisher

Indices and tables

• Index

• Module Index

• Search Page