From 51867cb055a767534f7569f93649b06c5734f32b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Le=20Guyader?= <loic.le.guyader@xfel.eu> Date: Mon, 10 Jan 2022 17:27:08 +0100 Subject: [PATCH] reorganize howto section --- doc/changelog.rst | 12 ++++++++++++ doc/howtos.rst | 34 ++++++++++++++-------------------- 2 files changed, 26 insertions(+), 20 deletions(-) diff --git a/doc/changelog.rst b/doc/changelog.rst index afe7bbf..69206ee 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -1,6 +1,18 @@ Release Notes ============= +unreleased +---------- + +- **Bug fixes** + +- **Improvements** + + - reorganize the Howto section :mr:`169` + +- **New Features** + + 1.5.0 ----- diff --git a/doc/howtos.rst b/doc/howtos.rst index ee0fce4..d9ea91e 100644 --- a/doc/howtos.rst +++ b/doc/howtos.rst @@ -3,23 +3,20 @@ How to's ~~~~~~~~ -top ---- +Loading run data +---------------- -.. * :doc:`load run and data <load>`. +* :doc:`load run and data <load>`. * :doc:`load data in memory <Loading_data_in_memory>`. -misc ----- +Reading the bunch pattern +------------------------- * :doc:`bunch pattern decoding <bunch_pattern_decoding>`. -detectors ---------- - DSSC -++++ +---- DSSC data binning ################# @@ -80,22 +77,13 @@ Most of the functions within toolbox_scs.detectors can be accessed directly. Thi * :doc:`bin data using the DSSCBinner <dssc/DSSCBinner>`. * post processing, data analysis -> *to be documented* -Point detectors -+++++++++++++++ -Detectors that produce one point per pulse, or 0D detectors, are all handled in a similar way. Such detectors are, for instance, the X-ray Gas Monitor (XGM), the Transmitted Intensity Monitor (TIM), the electron Bunch Arrival Monitor (BAM) or the photo diodes monitoring the PP laser. - -* :doc:`extract data from point detectors <point_detectors/point_detectors>`. - Photo-Electron Spectrometer (PES) -+++++++++++++++++++++++++++++++++ +--------------------------------- * :doc:`Basic analysis of PES spectra <PES_spectra_extraction>`. -routines --------- - BOZ: Beam-Splitting Off-axis Zone plate analysis -++++++++++++++++++++++++++++++++++++++++++++++++ +------------------------------------------------ The BOZ analysis consists of 4 notebooks and a script. The first notebook :doc:`BOZ analysis part I.a Correction determination <BOZ analysis part I.a Correction determination>` @@ -136,3 +124,9 @@ That small data h5 file can then be loaded and the data binned to compute a spectrum or a time resolved XAS scan using the fourth and final notebook :doc:`BOZ analysis part II.2 Binning <BOZ analysis part II.2 Binning>` +Point detectors +--------------- +Detectors that produce one point per pulse, or 0D detectors, are all handled in a similar way. Such detectors are, for instance, the X-ray Gas Monitor (XGM), the Transmitted Intensity Monitor (TIM), the electron Bunch Arrival Monitor (BAM) or the photo diodes monitoring the PP laser. + +* :doc:`extract data from point detectors <point_detectors/point_detectors>`. + -- GitLab