1 Presentation and Analytics Layer
2 ================================
7 The presentation and analytics layer (PAL) is the fourth layer of CSIT
8 hierarchy. The model of presentation and analytics layer consists of four
11 - sL1 - Data - input data to be processed:
13 - Static content - .rst text files, .svg static figures, and other files
14 stored in the CSIT git repository.
15 - Data to process - .xml files generated by Jenkins jobs executing tests,
16 stored as robot results files (output.xml).
17 - Specification - .yaml file with the models of report elements (tables,
18 plots, layout, ...) generated by this tool. There is also the configuration
19 of the tool and the specification of input data (jobs and builds).
21 - sL2 - Data processing
23 - The data are read from the specified input files (.xml) and stored as
24 multi-indexed `pandas.Series <https://pandas.pydata.org/pandas-docs/stable/
25 generated/pandas.Series.html>`_.
26 - This layer provides also interface to input data and filtering of the input
29 - sL3 - Data presentation - This layer generates the elements specified in the
32 - Tables: .csv files linked to static .rst files.
33 - Plots: .html files generated using plot.ly linked to static .rst files.
35 - sL4 - Report generation - Sphinx generates required formats and versions:
38 - versions: minimal, full (TODO: define the names and scope of versions)
46 \includesvg[width=0.90\textwidth]{../_tmp/src/csit_framework_documentation/pal_layers}
47 \label{fig:pal_layers}
52 .. figure:: pal_layers.svg
62 The report specification file defines which data is used and which outputs are
63 generated. It is human readable and structured. It is easy to add / remove /
64 change items. The specification includes:
66 - Specification of the environment.
67 - Configuration of debug mode (optional).
68 - Specification of input data (jobs, builds, files, ...).
69 - Specification of the output.
70 - What and how is generated:
71 - What: plots, tables.
72 - How: specification of all properties and parameters.
75 Structure of the specification file
76 '''''''''''''''''''''''''''''''''''
78 The specification file is organized as a list of dictionaries distinguished by
102 Each type represents a section. The sections "environment", "debug", "static",
103 "input" and "output" are listed only once in the specification; "table", "file"
104 and "plot" can be there multiple times.
106 Sections "debug", "table", "file" and "plot" are optional.
108 Table(s), files(s) and plot(s) are referred as "elements" in this text. It is
109 possible to define and implement other elements if needed.
115 This section has the following parts:
117 - type: "environment" - says that this is the section "environment".
118 - configuration - configuration of the PAL.
119 - paths - paths used by the PAL.
120 - urls - urls pointing to the data sources.
121 - make-dirs - a list of the directories to be created by the PAL while
122 preparing the environment.
123 - remove-dirs - a list of the directories to be removed while cleaning the
125 - build-dirs - a list of the directories where the results are stored.
127 The structure of the section "Environment" is as follows (example):
136 # - Download of input data files
138 # - Read data from given zip / xml files
139 # - Set the configuration as it is done in normal mode
140 # If the section "type: debug" is missing, CFG[DEBUG] is set to 0.
144 # Top level directories:
148 DIR[BUILD,HTML]: "_build"
149 DIR[BUILD,LATEX]: "_build_latex"
152 DIR[RST]: "../../../docs/report"
154 # Working directories
155 ## Input data files (.zip, .xml)
156 DIR[WORKING,DATA]: "{DIR[WORKING]}/data"
157 ## Static source files from git
158 DIR[WORKING,SRC]: "{DIR[WORKING]}/src"
159 DIR[WORKING,SRC,STATIC]: "{DIR[WORKING,SRC]}/_static"
161 # Static html content
162 DIR[STATIC]: "{DIR[BUILD,HTML]}/_static"
163 DIR[STATIC,VPP]: "{DIR[STATIC]}/vpp"
164 DIR[STATIC,DPDK]: "{DIR[STATIC]}/dpdk"
165 DIR[STATIC,ARCH]: "{DIR[STATIC]}/archive"
167 # Detailed test results
168 DIR[DTR]: "{DIR[WORKING,SRC]}/detailed_test_results"
169 DIR[DTR,PERF,DPDK]: "{DIR[DTR]}/dpdk_performance_results"
170 DIR[DTR,PERF,VPP]: "{DIR[DTR]}/vpp_performance_results"
171 DIR[DTR,PERF,HC]: "{DIR[DTR]}/honeycomb_performance_results"
172 DIR[DTR,FUNC,VPP]: "{DIR[DTR]}/vpp_functional_results"
173 DIR[DTR,FUNC,HC]: "{DIR[DTR]}/honeycomb_functional_results"
174 DIR[DTR,FUNC,NSHSFC]: "{DIR[DTR]}/nshsfc_functional_results"
175 DIR[DTR,PERF,VPP,IMPRV]: "{DIR[WORKING,SRC]}/vpp_performance_tests/performance_improvements"
177 # Detailed test configurations
178 DIR[DTC]: "{DIR[WORKING,SRC]}/test_configuration"
179 DIR[DTC,PERF,VPP]: "{DIR[DTC]}/vpp_performance_configuration"
180 DIR[DTC,FUNC,VPP]: "{DIR[DTC]}/vpp_functional_configuration"
182 # Detailed tests operational data
183 DIR[DTO]: "{DIR[WORKING,SRC]}/test_operational_data"
184 DIR[DTO,PERF,VPP]: "{DIR[DTO]}/vpp_performance_operational_data"
186 # .css patch file to fix tables generated by Sphinx
187 DIR[CSS_PATCH_FILE]: "{DIR[STATIC]}/theme_overrides.css"
188 DIR[CSS_PATCH_FILE2]: "{DIR[WORKING,SRC,STATIC]}/theme_overrides.css"
191 URL[JENKINS,CSIT]: "https://jenkins.fd.io/view/csit/job"
192 URL[JENKINS,HC]: "https://jenkins.fd.io/view/hc2vpp/job"
195 # List the directories which are created while preparing the environment.
196 # All directories MUST be defined in "paths" section.
197 - "DIR[WORKING,DATA]"
203 - "DIR[WORKING,SRC,STATIC]"
206 # List the directories which are deleted while cleaning the environment.
207 # All directories MUST be defined in "paths" section.
211 # List the directories where the results (build) is stored.
212 # All directories MUST be defined in "paths" section.
216 It is possible to use defined items in the definition of other items, e.g.:
220 DIR[WORKING,DATA]: "{DIR[WORKING]}/data"
222 will be automatically changed to
226 DIR[WORKING,DATA]: "_tmp/data"
229 Section: Configuration
230 ''''''''''''''''''''''
232 This section specifies the groups of parameters which are repeatedly used in the
233 elements defined later in the specification file. It has the following parts:
235 - data sets - Specification of data sets used later in element's specifications
236 to define the input data.
237 - plot layouts - Specification of plot layouts used later in plots'
238 specifications to define the plot layout.
240 The structure of the section "Configuration" is as follows (example):
245 type: "configuration"
247 plot-vpp-throughput-latency:
248 csit-vpp-perf-1710-all:
260 csit-vpp-perf-1710-all:
269 gridcolor: "rgb(238, 238, 238)"
270 linecolor: "rgb(238, 238, 238)"
275 tickcolor: "rgb(238, 238, 238)"
277 title: "Indexed Test Cases"
280 gridcolor: "rgb(238, 238, 238)'"
282 linecolor: "rgb(238, 238, 238)"
288 tickcolor: "rgb(238, 238, 238)"
289 title: "Packets Per Second [pps]"
305 The definitions from this sections are used in the elements, e.g.:
311 title: "VPP Performance 64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
312 algorithm: "plot_performance_box"
313 output-file-type: ".html"
314 output-file: "{DIR[STATIC,VPP]}/64B-1t1c-l2-sel1-ndrdisc"
316 "plot-vpp-throughput-latency"
317 filter: "'64B' and ('BASE' or 'SCALE') and 'NDRDISC' and '1T1C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
323 boxpoints: "outliers"
326 title: "64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
334 This section is optional as it configures the debug mode. It is used if one
335 does not want to download input data files and use local files instead.
337 If the debug mode is configured, the "input" section is ignored.
339 This section has the following parts:
341 - type: "debug" - says that this is the section "debug".
344 - input-format - xml or zip.
345 - extract - if "zip" is defined as the input format, this file is extracted
346 from the zip file, otherwise this parameter is ignored.
348 - builds - list of builds from which the data is used. Must include a job
349 name as a key and then a list of builds and their output files.
351 The structure of the section "Debug" is as follows (example):
358 input-format: "zip" # zip or xml
359 extract: "robot-plugin/output.xml" # Only for zip
361 # The files must be in the directory DIR[WORKING,DATA]
362 csit-dpdk-perf-1707-all:
365 file: "csit-dpdk-perf-1707-all__10.xml"
368 file: "csit-dpdk-perf-1707-all__9.xml"
369 csit-nsh_sfc-verify-func-1707-ubuntu1604-virl:
372 file: "csit-nsh_sfc-verify-func-1707-ubuntu1604-virl-2.xml"
373 csit-vpp-functional-1707-ubuntu1604-virl:
375 build: lastSuccessfulBuild
376 file: "csit-vpp-functional-1707-ubuntu1604-virl-lastSuccessfulBuild.xml"
377 hc2vpp-csit-integration-1707-ubuntu1604:
379 build: lastSuccessfulBuild
380 file: "hc2vpp-csit-integration-1707-ubuntu1604-lastSuccessfulBuild.xml"
381 csit-vpp-perf-1707-all:
384 file: "csit-vpp-perf-1707-all__16__output.xml"
387 file: "csit-vpp-perf-1707-all__17__output.xml"
393 This section defines the static content which is stored in git and will be used
394 as a source to generate the report.
396 This section has these parts:
398 - type: "static" - says that this section is the "static".
399 - src-path - path to the static content.
400 - dst-path - destination path where the static content is copied and then
406 src-path: "{DIR[RST]}"
407 dst-path: "{DIR[WORKING,SRC]}"
413 This section defines the data used to generate elements. It is mandatory
414 if the debug mode is not used.
416 This section has the following parts:
418 - type: "input" - says that this section is the "input".
419 - general - parameters common to all builds:
421 - file-name: file to be downloaded.
422 - file-format: format of the downloaded file, ".zip" or ".xml" are supported.
423 - download-path: path to be added to url pointing to the file, e.g.:
424 "{job}/{build}/robot/report/*zip*/{filename}"; {job}, {build} and
425 {filename} are replaced by proper values defined in this section.
426 - extract: file to be extracted from downloaded zip file, e.g.: "output.xml";
427 if xml file is downloaded, this parameter is ignored.
429 - builds - list of jobs (keys) and numbers of builds which output data will be
432 The structure of the section "Input" is as follows (example from 17.07 report):
437 type: "input" # Ignored in debug mode
439 file-name: "robot-plugin.zip"
441 download-path: "{job}/{build}/robot/report/*zip*/{filename}"
442 extract: "robot-plugin/output.xml"
444 csit-vpp-perf-1707-all:
456 csit-dpdk-perf-1707-all:
467 csit-vpp-functional-1707-ubuntu1604-virl:
468 - lastSuccessfulBuild
469 hc2vpp-csit-perf-master-ubuntu1604:
472 hc2vpp-csit-integration-1707-ubuntu1604:
473 - lastSuccessfulBuild
474 csit-nsh_sfc-verify-func-1707-ubuntu1604-virl:
481 This section specifies which format(s) will be generated (html, pdf) and which
482 versions will be generated for each format.
484 This section has the following parts:
486 - type: "output" - says that this section is the "output".
487 - format: html or pdf.
488 - version: defined for each format separately.
490 The structure of the section "Output" is as follows (example):
503 TODO: define the names of versions
506 Content of "minimal" version
507 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
509 TODO: define the name and content of this version
515 This section defines a table to be generated. There can be 0 or more "table"
518 This section has the following parts:
520 - type: "table" - says that this section defines a table.
521 - title: Title of the table.
522 - algorithm: Algorithm which is used to generate the table. The other
523 parameters in this section must provide all information needed by the used
525 - template: (optional) a .csv file used as a template while generating the
527 - output-file-ext: extension of the output file.
528 - output-file: file which the table will be written to.
529 - columns: specification of table columns:
531 - title: The title used in the table header.
532 - data: Specification of the data, it has two parts - command and arguments:
536 - template - take the data from template, arguments:
538 - number of column in the template.
540 - data - take the data from the input data, arguments:
542 - jobs and builds which data will be used.
544 - operation - performs an operation with the data already in the table,
547 - operation to be done, e.g.: mean, stdev, relative_change (compute
548 the relative change between two columns) and display number of data
549 samples ~= number of test jobs. The operations are implemented in the
551 TODO: Move from utils,py to e.g. operations.py
552 - numbers of columns which data will be used (optional).
554 - data: Specify the jobs and builds which data is used to generate the table.
555 - filter: filter based on tags applied on the input data, if "template" is
556 used, filtering is based on the template.
557 - parameters: Only these parameters will be put to the output data structure.
559 The structure of the section "Table" is as follows (example of
560 "table_performance_improvements"):
566 title: "Performance improvements"
567 algorithm: "table_performance_improvements"
568 template: "{DIR[DTR,PERF,VPP,IMPRV]}/tmpl_performance_improvements.csv"
569 output-file-ext: ".csv"
570 output-file: "{DIR[DTR,PERF,VPP,IMPRV]}/performance_improvements"
573 title: "VPP Functionality"
579 title: "VPP-16.09 mean [Mpps]"
582 title: "VPP-17.01 mean [Mpps]"
585 title: "VPP-17.04 mean [Mpps]"
588 title: "VPP-17.07 mean [Mpps]"
589 data: "data csit-vpp-perf-1707-all mean"
591 title: "VPP-17.07 stdev [Mpps]"
592 data: "data csit-vpp-perf-1707-all stdev"
594 title: "17.04 to 17.07 change [%]"
595 data: "operation relative_change 5 4"
597 csit-vpp-perf-1707-all:
612 Example of "table_details" which generates "Detailed Test Results - VPP
613 Performance Results":
619 title: "Detailed Test Results - VPP Performance Results"
620 algorithm: "table_details"
621 output-file-ext: ".csv"
622 output-file: "{DIR[WORKING]}/vpp_performance_results"
626 data: "data test_name"
628 title: "Documentation"
629 data: "data test_documentation"
632 data: "data test_msg"
634 csit-vpp-perf-1707-all:
642 Example of "table_details" which generates "Test configuration - VPP Performance
649 title: "Test configuration - VPP Performance Test Configs"
650 algorithm: "table_details"
651 output-file-ext: ".csv"
652 output-file: "{DIR[WORKING]}/vpp_test_configuration"
658 title: "VPP API Test (VAT) Commands History - Commands Used Per Test Case"
659 data: "data show-run"
661 csit-vpp-perf-1707-all:
673 This section defines a plot to be generated. There can be 0 or more "plot"
676 This section has these parts:
678 - type: "plot" - says that this section defines a plot.
679 - title: Plot title used in the logs. Title which is displayed is in the
681 - output-file-type: format of the output file.
682 - output-file: file which the plot will be written to.
683 - algorithm: Algorithm used to generate the plot. The other parameters in this
684 section must provide all information needed by plot.ly to generate the plot.
690 - These parameters are transparently passed to plot.ly.
692 - data: Specify the jobs and numbers of builds which data is used to generate
694 - filter: filter applied on the input data.
695 - parameters: Only these parameters will be put to the output data structure.
697 The structure of the section "Plot" is as follows (example of a plot showing
698 throughput in a chart box-with-whiskers):
704 title: "VPP Performance 64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
705 algorithm: "plot_performance_box"
706 output-file-type: ".html"
707 output-file: "{DIR[STATIC,VPP]}/64B-1t1c-l2-sel1-ndrdisc"
709 csit-vpp-perf-1707-all:
720 # Keep this formatting, the filter is enclosed with " (quotation mark) and
721 # each tag is enclosed with ' (apostrophe).
722 filter: "'64B' and 'BASE' and 'NDRDISC' and '1T1C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
728 boxpoints: "outliers"
731 title: "64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
736 gridcolor: "rgb(238, 238, 238)"
737 linecolor: "rgb(238, 238, 238)"
742 tickcolor: "rgb(238, 238, 238)"
744 title: "Indexed Test Cases"
747 gridcolor: "rgb(238, 238, 238)'"
749 linecolor: "rgb(238, 238, 238)"
755 tickcolor: "rgb(238, 238, 238)"
756 title: "Packets Per Second [pps]"
772 The structure of the section "Plot" is as follows (example of a plot showing
773 latency in a box chart):
779 title: "VPP Latency 64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
780 algorithm: "plot_latency_box"
781 output-file-type: ".html"
782 output-file: "{DIR[STATIC,VPP]}/64B-1t1c-l2-sel1-ndrdisc-lat50"
784 csit-vpp-perf-1707-all:
795 filter: "'64B' and 'BASE' and 'NDRDISC' and '1T1C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
802 title: "64B-1t1c-(eth|dot1q|dot1ad)-(l2xcbase|l2bdbasemaclrn)-ndrdisc"
807 gridcolor: "rgb(238, 238, 238)"
808 linecolor: "rgb(238, 238, 238)"
813 tickcolor: "rgb(238, 238, 238)"
815 title: "Indexed Test Cases"
818 gridcolor: "rgb(238, 238, 238)'"
820 linecolor: "rgb(238, 238, 238)"
826 tickcolor: "rgb(238, 238, 238)"
827 title: "Latency min/avg/max [uSec]"
847 This section defines a file to be generated. There can be 0 or more "file"
850 This section has the following parts:
852 - type: "file" - says that this section defines a file.
853 - title: Title of the table.
854 - algorithm: Algorithm which is used to generate the file. The other
855 parameters in this section must provide all information needed by the used
857 - output-file-ext: extension of the output file.
858 - output-file: file which the file will be written to.
859 - file-header: The header of the generated .rst file.
860 - dir-tables: The directory with the tables.
861 - data: Specify the jobs and builds which data is used to generate the table.
862 - filter: filter based on tags applied on the input data, if "all" is
863 used, no filtering is done.
864 - parameters: Only these parameters will be put to the output data structure.
865 - chapters: the hierarchy of chapters in the generated file.
866 - start-level: the level of the the top-level chapter.
868 The structure of the section "file" is as follows (example):
874 title: "VPP Performance Results"
875 algorithm: "file_test_results"
876 output-file-ext: ".rst"
877 output-file: "{DIR[DTR,PERF,VPP]}/vpp_performance_results"
878 file-header: "\n.. |br| raw:: html\n\n <br />\n\n\n.. |prein| raw:: html\n\n <pre>\n\n\n.. |preout| raw:: html\n\n </pre>\n\n"
879 dir-tables: "{DIR[DTR,PERF,VPP]}"
881 csit-vpp-perf-1707-all:
888 data-start-level: 2 # 0, 1, 2, ...
889 chapters-start-level: 2 # 0, 1, 2, ...
895 - Manually created / edited files.
896 - .rst files, static .csv files, static pictures (.svg), ...
897 - Stored in CSIT git repository.
899 No more details about the static content in this document.
905 The PAL processes tests results and other information produced by Jenkins jobs.
906 The data are now stored as robot results in Jenkins (TODO: store the data in
907 nexus) either as .zip and / or .xml files.
913 As the first step, the data are downloaded and stored locally (typically on a
914 Jenkins slave). If .zip files are used, the given .xml files are extracted for
917 Parsing of the .xml files is performed by a class derived from
918 "robot.api.ResultVisitor", only necessary methods are overridden. All and only
919 necessary data is extracted from .xml file and stored in a structured form.
921 The parsed data are stored as the multi-indexed pandas.Series data type. Its
922 structure is as follows:
932 "job name", "build", "metadata", "suites", "tests" are indexes to access the
961 Using indexes data["job 1 name"]["build 1"]["tests"] (e.g.:
962 data["csit-vpp-perf-1704-all"]["17"]["tests"]) we get a list of all tests with
965 Data will not be accessible directly using indexes, but using getters and
968 **Structure of metadata:**
973 "version": "VPP version",
974 "job": "Jenkins job name"
975 "build": "Information about the build"
978 **Structure of suites:**
984 "doc": "Suite 1 documentation"
985 "parent": "Suite 1 parent"
988 "doc": "Suite N documentation"
989 "parent": "Suite N parent"
992 **Structure of tests:**
1000 "name": "Test name",
1001 "parent": "Name of the parent of the test",
1002 "doc": "Test documentation"
1003 "msg": "Test message"
1004 "tags": ["tag 1", "tag 2", "tag n"],
1005 "type": "PDR" | "NDR",
1008 "unit": "pps" | "bps" | "percentage"
1017 "50": { # Only for NDR
1022 "10": { # Only for NDR
1034 "50": { # Only for NDR
1039 "10": { # Only for NDR
1046 "lossTolerance": "lossTolerance" # Only for PDR
1047 "vat-history": "DUT1 and DUT2 VAT History"
1049 "show-run": "Show Run"
1061 "name": "Test name",
1062 "parent": "Name of the parent of the test",
1063 "doc": "Test documentation"
1064 "msg": "Test message"
1065 "tags": ["tag 1", "tag 2", "tag n"],
1066 "vat-history": "DUT1 and DUT2 VAT History"
1067 "show-run": "Show Run"
1068 "status": "PASS" | "FAIL"
1075 Note: ID is the lowercase full path to the test.
1081 The first step when generating an element is getting the data needed to
1082 construct the element. The data are filtered from the processed input data.
1084 The data filtering is based on:
1089 - required data - only this data is included in the output.
1091 WARNING: The filtering is based on tags, so be careful with tagging.
1093 For example, the element which specification includes:
1098 csit-vpp-perf-1707-all:
1110 - "'64B' and 'BASE' and 'NDRDISC' and '1T1C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
1112 will be constructed using data from the job "csit-vpp-perf-1707-all", for all listed
1113 builds and the tests with the list of tags matching the filter conditions.
1115 The output data structure for filtered test data is:
1138 Data analytics part implements:
1140 - methods to compute statistical data from the filtered input data.
1145 Throughput Speedup Analysis - Multi-Core Speedup Ratio
1146 ''''''''''''''''''''''''''''''''''''''''''''''''''''''
1148 Throughput Speedup Analysis (TSA) calculates a speedup factor for 1, 2, 4 cores
1149 which is defined as:
1154 speedup factor = -----------------
1157 A bar plot displays the speedup factor (normalized throughput for 64B/78B on 1
1158 core). The plot displays number of cores on the X-axis and the speedup factor on
1161 For better comparision, there can be displayed more than one set of data in a
1162 plot. So, in general:
1164 - graph type: grouped bars;
1165 - graph X-axis: (testcase index, number of cores);
1166 - graph Y-axis: speedup factor.
1168 The data displayed is a subset of existing performance tests with 1core, 2core,
1171 :TODO: Specify the data model for TSA.
1174 Advanced data analytics
1175 ```````````````````````
1177 As the next steps, advanced data analytics (ADA) will be implemented using
1178 machine learning (ML) and artificial intelligence (AI).
1182 - describe the concept of ADA.
1183 - add specification.
1189 Generates the plots and tables according to the report models per
1190 specification file. The elements are generated using algorithms and data
1191 specified in their models.
1197 - tables are generated by algorithms implemented in PAL, the model includes the
1198 algorithm and all necessary information.
1199 - output format: csv
1200 - generated tables are stored in specified directories and linked to .rst files.
1206 - `plot.ly <https://plot.ly/>`_ is currently used to generate plots, the model
1207 includes the type of plot and all the necessary information to render it.
1208 - output format: html.
1209 - generated plots are stored in specified directories and linked to .rst files.
1215 Report is generated using Sphinx and Read_the_Docs template. PAL generates html
1216 and pdf formats. It is possible to define the content of the report by specifying
1217 the version (TODO: define the names and content of versions).
1223 1. Read the specification.
1224 2. Read the input data.
1225 3. Process the input data.
1226 4. For element (plot, table, file) defined in specification:
1228 a. Get the data needed to construct the element using a filter.
1229 b. Generate the element.
1230 c. Store the element.
1232 5. Generate the report.
1233 6. Store the report (Nexus).
1235 The process is model driven. The elements’ models (tables, plots, files and
1236 report itself) are defined in the specification file. Script reads the elements’
1237 models from specification file and generates the elements.
1239 It is easy to add elements to be generated, if a new kind of element is
1240 required, only a new algorithm is implemented and integrated.
1246 List of modules, classes, methods and functions
1247 ```````````````````````````````````````````````
1251 specification_parser.py
1274 input_data_parser.py
1315 Functions implementing algorithms to generate particular types of
1316 tables (called by the function "generate_tables"):
1318 table_performance_improvements
1326 Functions implementing algorithms to generate particular types of
1327 plots (called by the function "generate_plots"):
1328 plot_performance_box
1337 Functions implementing algorithms to generate particular types of
1338 files (called by the function "generate_files"):
1347 Functions implementing algorithms to generate particular types of
1348 report (called by the function "generate_report"):
1349 generate_html_report
1352 Other functions called by the function "generate_report":
1357 PAL functional diagram
1358 ``````````````````````
1366 \includesvg[width=0.90\textwidth]{../_tmp/src/csit_framework_documentation/pal_func_diagram}
1367 \label{fig:pal_func_diagram}
1372 .. figure:: pal_func_diagram.svg
1373 :alt: PAL functional diagram
1377 How to add an element
1378 `````````````````````
1380 Element can be added by adding its model to the specification file. If the
1381 element will be generated by an existing algorithm, only its parameters must be
1384 If a brand new type of element will be added, also the algorithm must be
1386 The algorithms are implemented in the files which names start with "generator".
1387 The name of the function implementing the algorithm and the name of algorithm in
1388 the specification file had to be the same.