Public Access
add more documentation: API doc
This commit is contained in:
1 parent
acd3352967
commit
b6ca2cbba3
2 files changed
+95
No files matched your search
@@ -0,0 +1,91 @@
|
||||
#############
|
||||
API Reference
|
||||
#############
|
||||
|
||||
This page provides an auto-generated reference of all DAMARIS classes, functions, and modules.
|
||||
It is built from docstrings using Sphinx autodoc and autosummary.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Modules:
|
||||
|
||||
damaris/data
|
||||
damaris/experiments
|
||||
damaris/gui
|
||||
damaris/tools
|
||||
|
||||
|
||||
Data Module
|
||||
===========
|
||||
|
||||
The data module contains result types, data handling, and signal processing classes.
|
||||
|
||||
.. autosummary::
|
||||
:toctree: _autosummary
|
||||
:recursive:
|
||||
|
||||
damaris.data.ADC_Result
|
||||
damaris.data.Accumulation
|
||||
damaris.data.DamarisFFT
|
||||
damaris.data.DataPool
|
||||
damaris.data.Drawable
|
||||
damaris.data.Errorable
|
||||
damaris.data.Error_Result
|
||||
damaris.data.MeasurementResult
|
||||
damaris.data.Persistance
|
||||
damaris.data.Resultable
|
||||
damaris.data.Signalpath
|
||||
damaris.data.Temperature
|
||||
damaris.data.autophase
|
||||
|
||||
|
||||
Experiments Module
|
||||
==================
|
||||
|
||||
The experiments module contains the Experiment class and related utilities for defining pulse sequences.
|
||||
|
||||
.. autosummary::
|
||||
:toctree: _autosummary
|
||||
:recursive:
|
||||
|
||||
damaris.experiments.Experiment
|
||||
damaris.experiments.DurationEstimator
|
||||
damaris.experiments.dac
|
||||
|
||||
|
||||
GUI Module
|
||||
==========
|
||||
|
||||
The GUI module contains the graphical interface, backend driver, and experiment/result handling.
|
||||
|
||||
.. autosummary::
|
||||
:toctree: _autosummary
|
||||
:recursive:
|
||||
|
||||
damaris.gui.BackendDriver
|
||||
damaris.gui.DamarisGUI
|
||||
damaris.gui.ExperimentHandling
|
||||
damaris.gui.ExperimentWriter
|
||||
damaris.gui.ResultHandling
|
||||
damaris.gui.ResultReader
|
||||
damaris.gui.TemperatureMonitor
|
||||
damaris.gui.logging_utils
|
||||
|
||||
|
||||
Tools Module
|
||||
============
|
||||
|
||||
The tools module contains hardware driver interfaces and utility functions.
|
||||
|
||||
.. autosummary::
|
||||
:toctree: _autosummary
|
||||
:recursive:
|
||||
|
||||
damaris.tools.eurotherm
|
||||
damaris.tools.flow_control
|
||||
damaris.tools.goniometer
|
||||
damaris.tools.lakeshore
|
||||
damaris.tools.ranges
|
||||
damaris.tools.signal
|
||||
damaris.tools.temperature
|
||||
damaris.tools.temperature_simulator
|
||||
Reference in new issue
Block a user