API doc

Classes

Main Classes

Pulse	Represents a general experimental pulse.
Criteria	A class for defining criteria for terminating experiments. This should
Parameter	Represents a sequence or pulse parameter.
Sequence	Represents an experimental pulse sequence.

Analysis Modules

FieldSweepAnalysis	Analysis and calculation of FieldSweep Experiment.
ResonatorProfileAnalysis	Analysis and calculation of resonator profiles.
CarrPurcellAnalysis	Analysis and calculation of Carr Purcell decay.
ReptimeAnalysis	Analysis and calculation of Reptime based saturation recovery.

Sequences

HahnEchoSequence	Represents a Hahn-Echo sequence.
T2RelaxationSequence	Represents a T2 relaxation sequence. A Hahn Echo where the interpulse delay increases
FieldSweepSequence	Represents a Field Sweep (EDFS) sequence.
ReptimeScan	Represents a reptime scan of a Hahn Echo Sequence.
CarrPurcellSequence	Represents a Carr-Purcell sequence.
ResonatorProfileSequence	Builds nutation based Resonator Profile sequence.
TWTProfileSequence	Builds TWT based Resonator Profile sequence.

Pulses

Pulse	Represents a general experimental pulse.
Detection	Represents a detection pulse.
Delay	DEPRECATION WARNING: THIS WILL BE REMOVED SOON.
RectPulse	Represents a rectangular monochromatic pulse.
GaussianPulse	Represents a Gaussian monochromatic pulse.
HSPulse	Represents a hyperboilc secant frequency-swept pulse.
ChirpPulse	Represents a linear frequency-swept pulse.
SincPulse	Represents a general experimental pulse.

Termination Criteria

Criteria	A class for defining criteria for terminating experiments. This should
TimeCriteria	A class for defining criteria for terminating experiments. This should
SNRCriteria	A class for defining criteria for terminating experiments. This should

Utilities

EPRAccessor

Interfaces

Interface	Represents the interface connection from autoEPR to the spectrometer.
BrukerAWG	Represents the interface for connecting to AWG based Bruker ELEXSYS-II
BrukerMPFU	Represents the interface for connecting to MPFU based Bruker ELEXSYS-II
XeprAPILink
ETH_awg_interface	Represents the interface for connecting to Andrin Doll style spectrometers.

Functions

I/O

eprload(path[, experiment, type])	A general versions of eprload
save_file(path, str)
create_dataset_from_sequence(data, sequence[, ...])
create_dataset_from_axes(data, axes[, params, axes_labels])
create_dataset_from_bruker(filepath)

Utilities

transpose_dict_of_list(d)	Turns a dictionary of lists into a list of dictionaries.
transpose_list_of_dicts(d)	Turns a list of dictionaries into a dictionary of lists.
round_step(value, step)
gcd(values)	Generates the greatest common dividor on a list of floats
sop(spins, comps)	Spin Operator Matricies.
write_pulsespel_file(sequence, d0[, AWG, MPFU, MaxGate])	Write the pulsespel file for a given sequence.