Skip to content

Description files for default templates #285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 8, 2025
Merged

Description files for default templates #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ac7d248
Add single_report md file, fix little issues with template filters
margalva Apr 4, 2025
d245bf7
Add files - one for each report template
margalva Apr 4, 2025
44c86b1
Simplify some filters. Add comparison report description
margalva Apr 4, 2025
f229f11
Update md for pptx export example
margalva Apr 4, 2025
f08cc64
Fix syntax
margalva Apr 4, 2025
d0f959a
Spelling mistakes
margalva Apr 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions default_templates/comparison_report.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down
89 changes: 89 additions & 0 deletions default_templates/comparison_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```
8 changes: 4 additions & 4 deletions default_templates/generic_fea.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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"
```


Expand Down
26 changes: 13 additions & 13 deletions default_templates/pptx_export.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"Template_0": {
"name": "Test_ppt",
"name": "PPTX Export Report",
"report_type": "Layout:pptx",
"tags": "",
"item_filter": "",
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -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,
Expand All @@ -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,
Expand All @@ -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,
Expand All @@ -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,
Expand All @@ -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,
Expand All @@ -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,
Expand All @@ -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,
Expand Down
Loading