Skip to content

API Reference

SpinDefectSim is organized into six subpackages. The table below maps each high-level concept to the relevant module.

Module map

Subpackage Module Key classes / functions
SpinDefectSim.base params Defaults, PhysicalParams
SpinDefectSim.base mixins PlottingMixin, SerializationMixin, SweepMixin
SpinDefectSim.spin defects DefectType, get_defect, list_defects
SpinDefectSim.spin hamiltonian SpinParams, SpinDefect, odmr_hamiltonian_Hz, …
SpinDefectSim.spin nuclear NuclearSpin, axial_A_tensor, isotope constants
SpinDefectSim.spin matrices spin_matrices
SpinDefectSim.spin rates RateParams, RateModel
SpinDefectSim.spin spectra PL_model, ensemble_odmr_spectrum, …
SpinDefectSim.spin echo ensemble_echo_signal, lock_in_difference_echo, …
SpinDefectSim.sensing protocols SensingExperiment
SpinDefectSim.sensing sequences RamseySequence, HahnEchoSequence, XY8Sequence
SpinDefectSim.sensing snr snr, noise_floor, n_avg_for_threshold
SpinDefectSim.analysis ensemble DefectEnsemble
SpinDefectSim.analysis sweep ParameterSweep
SpinDefectSim.electrometry electrometry ElectrometryExperiment
SpinDefectSim.electrometry efield E_gate_bias, E_disorder_point_charges, …
SpinDefectSim.magnetometry magnetometry MagnetometryExperiment
SpinDefectSim.magnetometry bfield B_from_wire_segment, B_from_magnetization_grid, …
SpinDefectSim.magnetometry geometry DiskGeometry, SquareGeometry, PolygonGeometry
SpinDefectSim.coulomb kernels G_rho, G_rz

Top-level imports

The most commonly used objects are re-exported from the top-level package for convenience:

import SpinDefectSim as sds

sds.SpinDefect          # SpinDefectSim.spin.hamiltonian.SpinDefect
sds.DefectEnsemble      # SpinDefectSim.analysis.ensemble.DefectEnsemble
sds.Defaults            # SpinDefectSim.base.params.Defaults

Reference pages