Add documentation for MKID detector
Following documentation should be reviewed and/or edited:
Pulse processing:
-
docstring for function pyxel.models.phasing.pulse_processing.pulse_processing
-
documentation for function pyxel.models.phasing.pulse_processing.pulse_processing
indocs/source/references/model_groups/phasing
-
general overview of model_group docs/source/references/model_groups/phasing
, like indocs/source/references/model_groups/photon generation
Simple phase conversion:
-
docstring for function pyxel.models.phasing.readout_electronics.phase_conversion
-
documentation for function pyxel.models.phasing.readout_electronics.phase_conversion
indocs/source/references/model_groups/readout_electronics
Dead time filter:
-
docstring for function pyxel.models.phasing.readout_electronics.dead_time_filter
-
documentation for function pyxel.models.phasing.readout_electronics.dead_time_filter
indocs/source/references/model_groups/readout_electronics
General MKID description:
-
Short intro of MKIDS in docs/source/background/detectors.rst
under MKID section with reference
Also:
-
Put reference literature in docs/source/refs.bib
and cite where necessary
Optional:
-
Quick check of docstrings in classes MKID
, 'MKIDCharacteristics' andMKIDGeometry
Edited by Enrico Biancalani