From da675dc2e686f512dc8a9eb10c02474bd7a3d859 Mon Sep 17 00:00:00 2001
From: ahmedk <karim.ahmed@xfel.eu>
Date: Wed, 5 Jul 2023 15:21:56 +0200
Subject: [PATCH] Update documents
1. Include calibration configurations and fix including the automated tests
2. Update the changelog
---
docs/development/testing_pipeline.md | 18 +++++++++++-------
docs/references/changelog.md | 28 ++++++++++++++++++++++++++++
mkdocs.yml | 6 ++++--
3 files changed, 43 insertions(+), 9 deletions(-)
diff --git a/docs/development/testing_pipeline.md b/docs/development/testing_pipeline.md
index ef9cfa9e1..4932b655f 100644
--- a/docs/development/testing_pipeline.md
+++ b/docs/development/testing_pipeline.md
@@ -15,12 +15,12 @@ affect the produced data quality.
2. Validate the number of HDF5 files against the number of HDF5 files in the reference folder.
3. Validate the numerical values of the processed data against the referenced data.
-
These tests are meant to run on all detector calibrations before any release. As well as run it per branch on the selected detector/calibration that is affected by the branch's changes.
## Current state
- Tests are defined by a callab_test.py DICT.
+
```py
{
"<test-name>(`<detector-calibration-operationMode>`)": {
@@ -67,7 +67,7 @@ These tests are meant to run on all detector calibrations before any release. As
In case a test fails the whole test fails and the next test starts.
-## Challenge for manually triggering the automated tests.
+## Challenge for manually triggering the automated tests
Currently these tests run by only one person before each release. Unfortunately, it is not use on individual branches and MRs as it is not exposed to all contributors.
@@ -76,10 +76,14 @@ Automating this test can solve the dependence on only one user to run the tests
It is preferred to run this automated test in a common place that is accessed by the calibration team to have more operators/monitors. This would result in a more active approach in solving any problem related to the testing pipeline or the tested detector calibrations.
Moreover exposing the running test would help in collecting more ideas and efforts in improving the testing pipeline.
-## Automating triggering the testing pipeline.
+## Automating triggering the testing pipeline
To automate the triggering:
- - Decide on a max-node to run the tests.
- - Currently the tests are manually triggered on a selected node and after the calibration execution is done all checks and validations are done on this selected node.
- - Create a cron job to schedule the automatic triggering for the tests.
- - Keep a logging format as a reporting tool for the test results.
+
+- Decide on a max-node to run the tests.
+
+ - Currently the tests are manually triggered on a selected node and after the calibration execution is done all checks and validations are done on this selected node.
+
+ - Create a cron job to schedule the automatic triggering for the tests.
+
+ - Keep a logging format as a reporting tool for the test results.
diff --git a/docs/references/changelog.md b/docs/references/changelog.md
index a570bb140..be73f2f94 100644
--- a/docs/references/changelog.md
+++ b/docs/references/changelog.md
@@ -1,6 +1,34 @@
# Release Notes
+## 3.10.3
+- [LPD][Correct] Harden against empty sequencee sets with train-on-demand
+- [JF][correct] Add missing gain mode parameter
+- [Timepix3] Add centroiding notebook
+
+## 3.10.2
+
+- [PNCCD][CORRECT] Fix: Skip error for missing gain
+- [PNCCD][CORRECT] Fix: Hack to wrong ctrl bias voltage values p002857
+
+- [LPD][Correct] Fix axis order for LPD-1M RelativeGain constant
+
+- [LPDMini][Dark] Add only number of available data trains into data_samples
+- [LPDMini][Dark] Fix first notebook cell to execute CL through the webservice
+- [LPDMini] Feat: Inject gain constants notebook
+
+- [Jungfrau] Workaround for `SPB_CFEL_JF1M` as the modules start with `09` not `01`
+
+- Fix update_config to work with non-AGIPD and add REMI
+
+## 3.10.1
+
+- [[JUNGFRAU][CORRECT] Using calcat interface](https://git.xfel.eu/calibration/pycalibration/-/merge_requests/775)
+- [[JUNGFRAU][CORRECT][DARK] Extend accepted detectors based on substrings of karabo_id](https://git.xfel.eu/calibration/pycalibration/-/merge_requests/839)
+
+- [[LPD Mini][CORRECT][DARK] Initial work on LPD Mini notebooks](https://git.xfel.eu/calibration/pycalibration/-/merge_requests/813)
+
+- [[PNCCD][CORRECT] Avoid raising a CalCat error while retrieving metadata for missing gain constant from DB](https://git.xfel.eu/calibration/pycalibration/-/merge_requests/837)
## 3.10.0
diff --git a/mkdocs.yml b/mkdocs.yml
index 32b2e0dfc..5b08073c2 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -89,7 +89,9 @@ nav:
- CALCAT: operation/calibration_database.md
- myMDC: operation/myMDC.md
- Available Calibration notebooks: operation/available_notebooks.md
- - Calibration webservice: operation/webservice.md
+ - Calibration webservice:
+ - The webservice: operation/webservice.md
+ - Calibration Configuration: operation/calibration_configurations.md
- Troubleshooting:
- Correcting detector RAW data: operation/troubleshooting_correction.md
- Calibration constant generation: operation/troubleshooting_calibration_generation.md
@@ -98,7 +100,7 @@ nav:
- Workflow: development/workflow.md
- How to write a notebook: development/how_to_write_xfel_calibrate_notebook_NBC.md
- Configuration: development/configuration.md
- - Automated tests: development/testing_pipeline
+ - Automated tests: development/testing_pipeline.md
- Code Reference: reference/
- Reference:
- FAQ: references/faq.md
--
GitLab