Debian Codegraph @

doc/features/validation/status.rst

raw
1 .. _validation_status:
2
3 Validation Status of DataLab
4 ============================
5
6 .. meta::
7 :description: Validation in DataLab, the open-source scientific data analysis and visualization platform
8 :keywords: DataLab, scientific, data, analysis, validation, ground-truth, analytical
9
10 Functional validation
11 ---------------------
12
13 In DataLab, functional validation is based on a classic test strategy (see
14 :ref:`functional_validation`).
15
16 .. list-table::
17 :header-rows: 1
18 :align: left
19
20 * - Package
21 - Coverage
22 - Number of tests
23 * - DataLab
24 - ~82%
25 - >130
26 * - Sigima
27 - ~90%
28 - >570
29
30 Technical validation
31 ---------------------
32
33 This paragraph provides the validation status of compute functions in DataLab (this is
34 what we call technical validation, see :ref:`scientific_validation`).
35
36 .. note:: This is a work in progress: the tables below are updated continuously as new
37 functions are validated or test code is adapted (the tables are generated from the
38 test code). Some functions are already validated but do not appear in the list
39 below yet, while others are still in the validation process.
40
41 .. warning:: The validation status must not be confused with the test coverage. The
42 validation status indicates whether the function has been validated against
43 ground-truth data or analytical models. The test coverage indicates the percentage
44 of the code that is executed by the test suite, but it does not necessarily take
45 into account the correctness of the results (DataLab's test coverage is around 90%).
46
47 .. csv-table:: Validation Statistics
48 :file: ../../validation_statistics.csv
49 :header: Category, Signal, Image, Total
50
51 Signal Compute Functions
52 ^^^^^^^^^^^^^^^^^^^^^^^^
53
54 The table below shows the validation status of signal compute functions in DataLab.
55 It is automatically generated from the source code.
56
57 .. csv-table:: Validation status of signal compute functions
58 :file: ../../validation_status_signal.csv
59 :header: Compute function, Description, Test function
60 :widths: 30, 40, 30
61
62 Image Compute Functions
63 ^^^^^^^^^^^^^^^^^^^^^^^
64
65 The table below shows the validation status of image compute functions in DataLab.
66 It is automatically generated from the source code.
67
68 .. csv-table:: Validation status of image compute functions
69 :file: ../../validation_status_image.csv
70 :header: Compute function, Description, Test function
71 :widths: 30, 40, 30