diff --git a/default_templates/comparison_report.json b/default_templates/comparison_report.json
index 92e3afc4d..e1e105373 100755
--- a/default_templates/comparison_report.json
+++ b/default_templates/comparison_report.json
@@ -28,7 +28,7 @@
"name": "Top",
"report_type": "Layout:panel",
"tags": "",
- "item_filter": "A|i_tags|cont|ReportType=Parametric;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "0"
@@ -148,7 +148,7 @@
"name": "Physics",
"report_type": "Layout:panel",
"tags": "",
- "item_filter": "A|i_tags|cont|'Design Point'='Base DP';O|i_type|eq|table;O|i_name|eq|ModelsTableItem;A|i_tags|cont|'Design Point'='Base DP';O|i_type|eq|tree;O|i_name|eq|MaterialsTreeItem;A|i_tags|cont|'Design Point'='Base DP';O|i_name|eq|CellZonesTreeItem;A|i_tags|cont|'Design Point'='Base DP';O|i_name|eq|BoundaryZonesTreeItem;A|i_tags|cont|'Design Point'='Base DP';O|i_name|eq|ReferenceValuesTableItem;A|i_tags|cont|'Design Point'='Base DP';",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "1",
@@ -281,7 +281,7 @@
"name": "Parametric Plots",
"report_type": "Layout:panel",
"tags": "",
- "item_filter": "A|i_type|cont|table;A|i_name|cont|parametric_plot;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "1",
@@ -318,7 +318,7 @@
"name": "Mesh",
"report_type": "Layout:panel",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_mesh;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "1",
@@ -339,7 +339,7 @@
"name": "MeshTabs",
"report_type": "Layout:tabs",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_mesh;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "0",
@@ -402,7 +402,7 @@
"name": "Contours",
"report_type": "Layout:panel",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_contour;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "1",
@@ -423,7 +423,7 @@
"name": "ContourTabs",
"report_type": "Layout:tabs",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_contour;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "0",
@@ -486,7 +486,7 @@
"name": "Pathlines",
"report_type": "Layout:panel",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_pathline;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "1",
@@ -507,7 +507,7 @@
"name": "PathlineTabs",
"report_type": "Layout:tabs",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_pathline;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "0",
@@ -637,7 +637,7 @@
"name": "Scenes",
"report_type": "Layout:panel",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_scene;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "1",
@@ -658,7 +658,7 @@
"name": "SceneTabs",
"report_type": "Layout:tabs",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_scene;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "0",
diff --git a/default_templates/comparison_report.md b/default_templates/comparison_report.md
new file mode 100644
index 000000000..8ddba9d3e
--- /dev/null
+++ b/default_templates/comparison_report.md
@@ -0,0 +1,89 @@
+# Comparison report
+
+Template for a report aggregating and comparing multiple simulations in the context of a parametric study. The user would be running multiple analysis of similar models / physics, and use this report template to visualize, compare and further analyze the results from all these design points into a single report.
+
+## Structure of the report
+
+The generated report will have the following structure:
+
+```text
+Report
+├── Logo
+├── Title
+├── Header
+├── Table of Content
+├── Design Points Table
+├── Base Case Simulation Setup
+│ ├── Physics
+│ | ├── Models
+│ | ├── Material Properties
+│ | ├── Cell Zones Conditions
+│ | ├── Boundary Conditions
+│ | ├── Reference Values
+│ ├── Solver Settings
+├── Parametrics Plots
+│ ├── ParametricPlotTabs
+├── Mesh
+│ ├── Mesh slider
+│ ├── Mesh comparison
+├── Contours
+│ ├── Contours slider
+│ ├── Contours comparison
+├── Pathlines
+│ ├── Pathlines slider
+│ ├── Pathlines comparison
+├── XY Plots
+│ ├── Static Pressure
+├── Scenes
+│ ├── Scenes slider
+│ ├── Scenes comparison
+```
+
+Note that the slide and comparison leafs (such as the Mesh slider and Mesh comparison) will display the same data in two different tabs, but in the slider case the images are collapsed into a single slider view, while in the comparison tab they are available side-by-side for quick comparison. The differences are set in the template properties.
+
+Note that the "XY Plots" will do a merge of all tables coming from all design points to display the values all in a single plot for easier comparison between simulation results.
+
+You can add or modify the structure of the report by adding / removing / modifying the corresponding report templates.
+
+## Filters
+
+Each report section is populated with items from the database that pass the aggregated filters. You can modify these filters to fit your database.
+
+The report is written assuming that all data is tagged with a 'Design Point=DPX' tag that marks which design point each item refers to. Please adjust the filters accordingly if this isn't the case in you database.
+
+At the top level, there is a filter for item tags containing the string 'Design Point' and 'ReportType=Parametric'.
+
+The following tree displays the filter for each report leaf. This template mainly uses item names, types and tags to place them in the correct section.
+
+```text
+Report -> Items with 'Design Point' and 'ReportType=Parametric' in the tag
+├── Logo -> Image itam with name "AnsysLogo" or "UserLogo"
+├── Title -> HTML item with name "ReportTitle"
+├── Header -> Table item with name "HeaderTableItem"
+├── Table of Content -> NO ITEMS HERE. Table of Content is automatically generated
+├── Design Points Table -> Table item with name "ParameterDesignPointsTable"
+├── Base Case Simulation Setup
+│ ├── Physics
+│ | ├── Models -> Table item with name "ModelsTableItem" and tags with "'Design Point'='Base DP'"
+│ | ├── Material Properties -> Tree item with name "MaterialsTreeItem" and tags with "'Design Point'='Base DP'"
+│ | ├── Cell Zones Conditions -> Tree item with name "CellZonesTreeItem" and tags with "'Design Point'='Base DP'"
+│ | ├── Boundary Conditions -> Tree item with name "BoundaryZonesTreeItem" and tags with "'Design Point'='Base DP'"
+│ | ├── Reference Values -> Tree item with name "ReferenceValuesTableItem" and tags with "'Design Point'='Base DP'"
+│ ├── Solver Settings -> Tree item with name "SolverSettingsTreeItem" and tags with "'Design Point'='Base DP'"
+├── Parametrics Plots
+│ ├── ParametricPlotTabs -> Table item with name that contains '_parametric_plot'
+├── Mesh
+│ ├── Mesh slider -> Image items with "_mesh" in the name
+│ ├── Mesh comparison -> Image items with "_mesh" in the name
+├── Contours
+│ ├── Contours slider -> Image items with "_contour" in the name
+│ ├── Contours comparison -> Image items with "_contour" in the name
+├── Pathlines
+│ ├── Pathlines slider -> Image items with "_pathline" in the name
+│ ├── Pathlines comparison -> Image items with "_pathline" in the name
+├── XY Plots -> Table items with "_xyplot" in the name
+│ ├── Static Pressure -> Items with "top-wall_xyplot" in the name
+├── Scenes
+│ ├── Scenes slider -> Image items with "_scene" in the name
+│ ├── Scenes comparison -> Image items with "_scene" in the name
+```
diff --git a/default_templates/generic_fea.md b/default_templates/generic_fea.md
index cab46cecc..fe25d7f70 100644
--- a/default_templates/generic_fea.md
+++ b/default_templates/generic_fea.md
@@ -37,8 +37,8 @@ Report
│ ├── Summary
│ ├── Recommendations
├── Appendices
-│ ├── Appendix-A
-│ ├── Appendix-B
+ ├── Appendix-A
+ ├── Appendix-B
```
You can add or modify the structure of the report by adding / removing / modifying the corresponding report templates.
@@ -82,8 +82,8 @@ Report -> item tag contains "projectA"
│ ├── Summary -> item tags contain "session=summary"
│ ├── Recommendations -> item tags contain "session=recommendations"
├── Appendices -> item name contain "chapter=appendices"
-│ ├── Appendix-A -> item tags contain "session=appendixA"
-│ ├── Appendix-B -> item tags contain "session=appendixB"
+ ├── Appendix-A -> item tags contain "session=appendixA"
+ ├── Appendix-B -> item tags contain "session=appendixB"
```
diff --git a/default_templates/pptx_export.json b/default_templates/pptx_export.json
index a5b4e46dd..e50845d90 100644
--- a/default_templates/pptx_export.json
+++ b/default_templates/pptx_export.json
@@ -1,6 +1,6 @@
{
"Template_0": {
- "name": "Test_ppt",
+ "name": "PPTX Export Report",
"report_type": "Layout:pptx",
"tags": "",
"item_filter": "",
@@ -101,7 +101,7 @@
"name": "Geometry and Mesh_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_type|eq|table;",
+ "item_filter": "",
"params": {
"properties": {
"source_slide": 5,
@@ -173,7 +173,7 @@
"name": "Simulation Setup_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_type|eq|table;",
+ "item_filter": "",
"params": {
"properties": {
"source_slide": 9,
@@ -193,7 +193,7 @@
"name": "Physics_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_type|eq|table;",
+ "item_filter": "",
"params": {
"properties": {
"source_slide": 10,
@@ -386,7 +386,7 @@
"name": "Plots_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_type|eq|table;A|i_name|cont|_plot;",
+ "item_filter": "",
"params": {
"properties": {
"source_slide": 21,
@@ -424,7 +424,7 @@
"name": "Report Plots_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_type|eq|table;A|i_name|cont|_plot;",
+ "item_filter": "",
"params": {
"properties": {
"source_slide": 23,
@@ -443,7 +443,7 @@
"name": "Report Plots_child_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_name|cont|_plot;",
+ "item_filter": "A|i_type|eq|table;A|i_name|cont|_plot;",
"params": {
"properties": {
"source_slide": 24,
@@ -461,7 +461,7 @@
"name": "Mesh_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_mesh;",
+ "item_filter": "",
"params": {
"properties": {
"source_slide": 25,
@@ -480,7 +480,7 @@
"name": "Mesh_child_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_name|cont|_mesh;",
+ "item_filter": "A|i_type|eq|image;A|i_name|cont|_mesh;",
"params": {
"properties": {
"source_slide": 26,
@@ -497,7 +497,7 @@
"name": "Pathlines_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_pathline;",
+ "item_filter": "",
"params": {
"properties": {
"source_slide": 31,
@@ -516,7 +516,7 @@
"name": "Pathlines_child_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_name|cont|_pathline;",
+ "item_filter": "A|i_type|eq|image;A|i_name|cont|_pathline;",
"params": {
"properties": {
"source_slide": 32,
@@ -533,7 +533,7 @@
"name": "Contours_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_type|eq|image;A|i_name|cont|_contour;",
+ "item_filter": "",
"params": {
"properties": {
"source_slide": 27,
@@ -552,7 +552,7 @@
"name": "Contours_child_template_ppt",
"report_type": "Layout:pptxslide",
"tags": "",
- "item_filter": "A|i_name|cont|_contour;",
+ "item_filter": "A|i_type|eq|image;A|i_name|cont|_contour;",
"params": {
"properties": {
"source_slide": 28,
diff --git a/default_templates/pptx_export.md b/default_templates/pptx_export.md
new file mode 100644
index 000000000..49d293ca7
--- /dev/null
+++ b/default_templates/pptx_export.md
@@ -0,0 +1,82 @@
+# PPTX export report
+
+Report template for a report to export in PPTX. Please note that for this to work, the database needs to contain a PPTX file called "Simulation_Report_input_ppt.pptx" with master slides and placeholders that describe how each item will be rendered in the exported PPTX file.
+
+## Structure of the report
+
+For each leaf template, the properties need to include "source_slide" to point to which master slide to use from the input PPTX file as a source for this leaf.
+The generated PPTX file will have the following structure:
+
+```text
+Report
+├── ReportTitleText_template_ppt
+├── TOC_template_ppt
+├── Header_template_ppt
+├── System Information_template_ppt
+├── Geometry and Mesh_template_ppt
+│ ├── Mesh Size_template_ppt
+│ ├── Mesh Quality_template_ppt
+│ ├── Orthogonal Quality_template_ppt
+├── Simulation Setup_template_ppt
+│ ├── Physics_template_ppt
+│ ├── ├── Models_template_ppt
+│ ├── ├── Material Properties_template_ppt
+│ ├── ├── Cell Zones Conditions_template_ppt
+│ ├── ├── Boundary Conditions_template_ppt
+│ ├── ├── Reference Values_template_ppt
+│ ├── Solver Settings_template_ppt
+├── Run Information_template_ppt
+├── Solution Status_template_ppt
+├── Named Expressions_template_ppt
+├── Report Definitions_template_ppt
+├── Plots_template_ppt
+│ ├── Residuals_template_ppt
+│ ├── Residual Plots_template_ppt
+│ ├── ├── Residual Plots_child_template_ppt
+├── Mesh_template_ppt
+│ ├── Mesh_child_template_ppt
+├── Pathlines_template_ppt
+│ ├── Pathlines_child_template_ppt
+├── Contours_template_ppt
+ ├── Contours_child_template_ppt
+```
+
+## Filters
+
+Each report section is populated with items from the database that pass the aggregated filters. You can modify these filters to fit your database.
+
+The following tree displays the filter for each report leaf. The idea is to use item names and types to place them in the correct section.
+
+```text
+Report
+├── ReportTitleText_template_ppt
+├── TOC_template_ppt
+├── Header_template_ppt -> Table item with name "HeaderTableItem"
+├── System Information_template_ppt -> Table item with name "SystemTableItem"
+├── Geometry and Mesh_template_ppt
+│ ├── Mesh Size_template_ppt -> Table item with name "MeshSizeTableItem"
+│ ├── Mesh Quality_template_ppt -> Table item with name "MeshQualityTableItem"
+│ ├── Orthogonal Quality_template_ppt -> Table item with name "MeshSizeTableItem"
+├── Simulation Setup_template_ppt -> Table image with name "MeshOrthogonalHistogram"
+│ ├── Physics_template_ppt
+│ ├── ├── Models_template_ppt -> Table item with name "ModelsTableItem"
+│ ├── ├── Material Properties_template_ppt -> Tree item with name "MaterialsTreeItem"
+│ ├── ├── Cell Zones Conditions_template_ppt -> Tree item with name "CellZonesTreeItem"
+│ ├── ├── Boundary Conditions_template_ppt -> Tree item with name "Boundary"
+│ ├── ├── Reference Values_template_ppt -> Table item with name "ReferenceValuesTableItem"
+│ ├── Solver Settings_template_ppt -> Tree item with name "SolverSettingsTreeItem"
+├── Run Information_template_ppt -> Table item with name "RunTableItem"
+├── Solution Status_template_ppt -> Table item with name "SolverStatusTableItem"
+├── Named Expressions_template_ppt -> Table item with name "ExpressionsTableItem"
+├── Report Definitions_template_ppt -> Table item with name "ReportDefinitionsTreeItem"
+├── Plots_template_ppt
+│ ├── Residuals_template_ppt -> Table item with name "residuals_plot"
+│ ├── Residual Plots_template_ppt
+│ ├── ├── Residual Plots_child_template_ppt -> Table item with name "_plot"
+├── Mesh_template_ppt
+│ ├── Mesh_child_template_ppt -> Image item with name "_mesh_"
+├── Pathlines_template_ppt
+│ ├── Pathlines_child_template_ppt -> Image item with name "_pathline"
+├── Contours_template_ppt
+ ├── Contours_child_template_ppt -> Image item with name "_contour"
+```
\ No newline at end of file
diff --git a/default_templates/single_report.json b/default_templates/single_report.json
index e83fc7c87..21309599a 100644
--- a/default_templates/single_report.json
+++ b/default_templates/single_report.json
@@ -550,7 +550,7 @@
"name": "contour-2",
"report_type": "Layout:basic",
"tags": "",
- "item_filter": "A|i_type|cont|image;A|i_name|eq|contour-1;",
+ "item_filter": "A|i_type|cont|image;A|i_name|cont|contour-2;",
"params": {
"properties": {
"TOCItem": "0",
@@ -630,7 +630,7 @@
"TOCItem": "0",
"pagebreak": "0"
},
- "HTML": "pathlines-1
",
+ "HTML": "pathlines-2
",
"skip_empty": 0
},
"sort_selection": "",
@@ -641,7 +641,7 @@
"name": "Scenes",
"report_type": "Layout:panel",
"tags": "",
- "item_filter": "A|i_type|cont|scene;O|i_name|cont|_scene;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "1",
@@ -708,7 +708,7 @@
"width": 960,
"height": 720
},
- "HTML": "scene-1
",
+ "HTML": "scene-2
",
"skip_empty": 0
},
"sort_selection": "",
@@ -719,7 +719,7 @@
"name": "Animations",
"report_type": "Layout:panel",
"tags": "",
- "item_filter": "A|i_type|cont|anim;",
+ "item_filter": "",
"params": {
"properties": {
"TOCItem": "1",
diff --git a/default_templates/single_report.md b/default_templates/single_report.md
new file mode 100644
index 000000000..3ecfac6d2
--- /dev/null
+++ b/default_templates/single_report.md
@@ -0,0 +1,87 @@
+# Single simulation report
+
+Basic report template for a single simulation. The report covers from the problem statement to the mesh and solver settings, and simulation results.
+
+## Structure of the report
+
+The generated report will have the following structure:
+
+```text
+Report
+├── Logo
+├── Title
+├── Header
+├── Table of Content
+├── System Information
+├── Geometry and Mesh
+│ ├── Mesh Size
+│ ├── Mesh Quality
+│ ├── Orthogonal Quality
+├── Simulation Setup
+│ ├── Physics
+│ | ├── Models
+│ | ├── Material Properties
+│ | ├── Boundary Conditions
+│ | ├── Reference Values
+│ ├── Solver Settings
+├── Run Information
+├── Solution Status
+├── Plots
+│ ├── Tabs of plots
+├── Mesh
+│ ├── Tabs of mesh images
+├── Contours
+│ ├── Tabs of contours images
+├── Pathlines
+│ ├── Tabs of pathline images
+├── Scenes
+│ ├── Tabs of 3D scenes
+├── Animations
+ ├── Tabs of animation files
+```
+
+You can add or modify the structure of the report by adding / removing / modifying the corresponding report templates.
+
+## Filters
+
+Each report section is populated with items from the database that pass the aggregated filters. You can modify these filters to fit your database.
+
+At the top level, there is a filter for item tags containing the string 'simulation=runA'. The idea is to isolate items related to a specific simulation run. Only items that pass this filter will be added into the report.
+
+The following tree displays the filter for each report leaf. This template mainly uses item names, types and tags to place them in the correct section.
+
+```text
+Report -> item tag contains "simulation=runA"
+├── Logo -> item is an image with name "AnsysLogo" or "UserLogo"
+├── Title -> item is of HTML type with name "ReportTitle"
+├── Header -> item is a table with name "HeaderTableItem"
+├── Table of Content -> NO ITEMS HERE. Table of Content is automatically generated
+├── System Information -> Table item with name "SystemTableItem"
+├── Geometry and Mesh
+│ ├── Mesh Size -> Table item with name "MeshSizeTableItem"
+│ ├── Mesh Quality -> Table item with name "MeshQualityTableItem"
+│ ├── Orthogonal Quality -> Image item with name "MeshOrthogonalHistogram"
+├── Simulation Setup
+│ ├── Physics
+│ | ├── Models -> Table item with name "ModelsTableItem"
+│ | ├── Material Properties -> Tree item with name "MaterialsTreeItem"
+│ | ├── Boundary Conditions -> Tree item with name "BoundaryZonesTreeItem"
+│ | ├── Reference Values -> Table item with name "ReferenceValuesTableItem"
+│ ├── Solver Settings -> Tree item with name "SolverSettingsTreeItem"
+├── Run Information -> Table item with name "RunTableItem"
+├── Solution Status -> Table item with name "SolverStatusTableItem"
+├── Plots
+│ ├── Tabs of plots -> Table item with name "residuals_plot"
+├── Mesh
+│ ├── Tabs of mesh images -> Image item with name "mesh1"
+├── Contours
+│ ├── Tabs of contours images -> Image item with name that contains "_contour1" or "_contour2"
+├── Pathlines
+│ ├── Tabs of pathline images -> Image item with name "pathlines-1" or "pathlines-2"
+├── Scenes
+│ ├── Tabs of 3D scenes -> Scene item with name that contains "scene-1" or "scene-2"
+├── Animations
+ ├── Tabs of animation files -> Animation item with name that contains "animation-1" or "animation-2"
+```
+
+For the tabs sections, you can create a new template child for each object you want to place in a separate tab. Remember to set the filters correctly on each child template. This is just an example to place one or two tabs on each of these sections.
\ No newline at end of file