From 5d6d8f2f9642a84d2d643dd3d3d073125f60bca9 Mon Sep 17 00:00:00 2001
From: sroscher <s.roscher@tu-berlin.de>
Date: Wed, 5 Feb 2025 16:42:40 +0100
Subject: [PATCH 1/2] - Added python images to
`assets/images/developer/style/modularization` - Added python template folder
- python-modularization.md: Updated paths to images and added one new image;
updated some text; added link to example folder
---
...thon-modularization_01_code-modularity.png | 3 +
...ython-modularization_02_example-folder.png | 3 +
..._example-folder-changes-module-manager.png | 3 +
.../python-modularization_04_main-01.png | 3 +
.../python-modularization_05_main-02.png | 3 +
...modularization_06_datapreprocessing-01.png | 3 +
...modularization_07_datapreprocessing-02.png | 3 +
...odularization_08_datapostprocessing-01.png | 3 +
...odularization_09_datapostprocessing-02.png | 3 +
...ization_10_example-folder-changes-user.png | 3 +
...dularization_11_unicado-python-library.png | 3 +
.../python-modularization_12_toml_file.png | 3 +
.../modularization/python-modularization.md | 109 +-
.../cost_estimation/CMakeLists.txt | 80 +
.../AircraftDesign/cost_estimation/Icon\r" | 0
.../cost_estimation/cost_estimation.log | 117 +
.../cost_estimation/cost_estimation_conf.xml | 311 ++
.../cost_estimation/doc/Doxyfile | 2824 ++++++++++
.../cost_estimation/doc/DoxygenLayout.xml | 242 +
.../doc/content/getting_started.md | 339 ++
.../cost_estimation/doc/content/index.md | 16 +
.../doc/content/operating_cost_method.md | 3 +
.../doc/content/software_architecture.md | 2 +
.../cost_estimation/doc/header.html | 86 +
.../AircraftDesign/cost_estimation/main.py | 88 +
.../cost_estimation/src/Icon\r" | 0
.../src/blended_wing_body/Icon\r" | 0
.../cost_estimation/src/datapostprocessing.py | 81 +
.../cost_estimation/src/datapreprocessing.py | 126 +
.../cost_estimation/src/readlayertext.py | 86 +
.../cost_estimation/src/tube_and_wing/Icon\r" | 0
.../src/tube_and_wing/empirical/Icon\r" | 0
.../Icon\r" | 0
.../general/Icon\r" | 0
.../general/methodhtmlreport.py | 19 +
.../general/methodplot.py | 23 +
.../general/methodtexoutput.py | 19 +
.../general/methodxmlexport.py | 103 +
.../kerosene/Icon\r" | 0
.../methodkerosene.cpython-311.pyc | Bin 0 -> 2179 bytes
.../kerosene/methodkerosene.py | 35 +
.../liquid_hydrogen/Icon\r" | 0
.../liquid_hydrogen/methodliquidhydrogen.py | 34 +
.../usermethoddatapreparation.py | 211 +
.../cost_estimation/version.txt | 1 +
.../projects/CSR/CSR-02/CSR-02.xml | 4832 +++++++++++++++++
.../plots/[module name]_[name of plot].txt | 0
.../report_xml/cost_estimation_results.xml | 46 +
.../pymodulepackage/CMakeLists.txt | 4 +
.../pymodulepackage/LICENSE | 674 +++
.../pymodulepackage/README.md | 31 +
.../pymodulepackage/pyproject.toml | 20 +
.../src/datapostprocessingmodule.py | 930 ++++
.../src/datapreprocessingmodule.py | 776 +++
.../pymodulepackage/src/runmodule.py | 54 +
.../src/runtimeoutputmodule.py | 123 +
56 files changed, 12413 insertions(+), 68 deletions(-)
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_01_code-modularity.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_02_example-folder.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_03_example-folder-changes-module-manager.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_04_main-01.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_05_main-02.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_06_datapreprocessing-01.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_07_datapreprocessing-02.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_08_datapostprocessing-01.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_09_datapostprocessing-02.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_10_example-folder-changes-user.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_11_unicado-python-library.png
create mode 100644 docs/assets/images/developer/style/modularization/python-modularization_12_toml_file.png
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/CMakeLists.txt
create mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/Icon\r"
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation.log
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation_conf.xml
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/Doxyfile
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/DoxygenLayout.xml
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/getting_started.md
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/index.md
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/operating_cost_method.md
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/software_architecture.md
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/header.html
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/main.py
create mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/Icon\r"
create mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/blended_wing_body/Icon\r"
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/datapostprocessing.py
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/datapreprocessing.py
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/readlayertext.py
create mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/Icon\r"
create mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/Icon\r"
create mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/Icon\r"
create mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/Icon\r"
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodhtmlreport.py
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodplot.py
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodtexoutput.py
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodxmlexport.py
create mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/Icon\r"
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/__pycache__/methodkerosene.cpython-311.pyc
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/methodkerosene.py
create mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/liquid_hydrogen/Icon\r"
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/liquid_hydrogen/methodliquidhydrogen.py
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/usermethoddatapreparation.py
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/version.txt
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/CSR-02.xml
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/reporting/plots/[module name]_[name of plot].txt
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/reporting/report_xml/cost_estimation_results.xml
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/CMakeLists.txt
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/LICENSE
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/README.md
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/pyproject.toml
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/datapostprocessingmodule.py
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/datapreprocessingmodule.py
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/runmodule.py
create mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/runtimeoutputmodule.py
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_01_code-modularity.png b/docs/assets/images/developer/style/modularization/python-modularization_01_code-modularity.png
new file mode 100644
index 0000000..0a29d3a
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_01_code-modularity.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:03b4c572759cf886f6d2b5d44c51346bf42da6daa4aef402917c75b5435a574d
+size 155693
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_02_example-folder.png b/docs/assets/images/developer/style/modularization/python-modularization_02_example-folder.png
new file mode 100644
index 0000000..4e63fdf
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_02_example-folder.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7fba9e2393c5bb763d410e7352de52474be41d9b796bfdd005311ee0f3c7e5c8
+size 195802
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_03_example-folder-changes-module-manager.png b/docs/assets/images/developer/style/modularization/python-modularization_03_example-folder-changes-module-manager.png
new file mode 100644
index 0000000..97d4239
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_03_example-folder-changes-module-manager.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8144d9b8320a8a374321cccf0e49764145c91fb3928beec742764a6cb7f9b4af
+size 196101
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_04_main-01.png b/docs/assets/images/developer/style/modularization/python-modularization_04_main-01.png
new file mode 100644
index 0000000..1917294
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_04_main-01.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:796488f22857b95660e1a0bffb47a219f67a62009aa54d37bca46e1546efafa3
+size 331123
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_05_main-02.png b/docs/assets/images/developer/style/modularization/python-modularization_05_main-02.png
new file mode 100644
index 0000000..f6cf1c0
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_05_main-02.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b7c64a0120f6d16d2cf93143f51eb1b882f6f87da4883da62c5d46d2387da3ee
+size 290488
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_06_datapreprocessing-01.png b/docs/assets/images/developer/style/modularization/python-modularization_06_datapreprocessing-01.png
new file mode 100644
index 0000000..9abb406
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_06_datapreprocessing-01.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1c7ec64acb94c52dcab1b915762df5589ab4f4ac8a43ffedcf813fc521868983
+size 313579
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_07_datapreprocessing-02.png b/docs/assets/images/developer/style/modularization/python-modularization_07_datapreprocessing-02.png
new file mode 100644
index 0000000..886f23a
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_07_datapreprocessing-02.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e4a7abe707b8edf50e570a47b7c96bf5ed6bfcb0dc653515c78f2b1b6b783bce
+size 363406
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_08_datapostprocessing-01.png b/docs/assets/images/developer/style/modularization/python-modularization_08_datapostprocessing-01.png
new file mode 100644
index 0000000..0a1b8ae
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_08_datapostprocessing-01.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4b40d19b9cf7fc6f5b3312b34c61233fd7ce9f47363af0d91386f4f6eac3e481
+size 297481
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_09_datapostprocessing-02.png b/docs/assets/images/developer/style/modularization/python-modularization_09_datapostprocessing-02.png
new file mode 100644
index 0000000..4e697a3
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_09_datapostprocessing-02.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3d927e8d9d6f6c5ba4ff9fafd6252d3cf154d74183493340d30ff56865ee230b
+size 309195
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_10_example-folder-changes-user.png b/docs/assets/images/developer/style/modularization/python-modularization_10_example-folder-changes-user.png
new file mode 100644
index 0000000..3bd32da
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_10_example-folder-changes-user.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:feac17192622ff3fb8c215979c58943f6810b6a8a64feda4f2891fcd73cf12e8
+size 195890
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_11_unicado-python-library.png b/docs/assets/images/developer/style/modularization/python-modularization_11_unicado-python-library.png
new file mode 100644
index 0000000..79eb03f
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_11_unicado-python-library.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d49e7060d87384eafd9653981286d320579e6f2be64053b4e65fec84b9d03751
+size 139372
diff --git a/docs/assets/images/developer/style/modularization/python-modularization_12_toml_file.png b/docs/assets/images/developer/style/modularization/python-modularization_12_toml_file.png
new file mode 100644
index 0000000..f807921
--- /dev/null
+++ b/docs/assets/images/developer/style/modularization/python-modularization_12_toml_file.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2fb99f03e5d110fe7abf2cbd116830de6d86b9a78ca40336c4812703224760ff
+size 233783
diff --git a/docs/get-involved/modularization/python-modularization.md b/docs/get-involved/modularization/python-modularization.md
index d9851f6..186e9b9 100644
--- a/docs/get-involved/modularization/python-modularization.md
+++ b/docs/get-involved/modularization/python-modularization.md
@@ -2,7 +2,7 @@
This documentation provides a detailed overview of helpful guidelines and conventions for the use/implementation of Python code in the UNICADO framework.
!!! note
- The content below is valid for UNICADO release v2.0.
+ The content below is valid for UNICADO release v3.0.0.
# Content
- [Introduction](#introduction)
@@ -29,7 +29,7 @@ The UNICADO Python Library is designed to streamline and standardize Python-base
With its structured layers and well-defined documentation and logging practices, the UNICADO Library enables developers to produce modular, reusable, and well-documented code. This guide ensures developers can build and maintain code to the standards expected within the UNICADO framework, promoting compatibility and readiness for team-based development, testing, and deployment. The result is improved code quality, reusability, and maintainability across complex projects.
# Code style {#code-style}
-...
+Below, you find some information on UNICADO code style basics.
## Python Enhancement Proposals (PEPs)
Let's start with an obvious question ... [What is a PEP?](https://peps.python.org/pep-0001/#what-is-a-pep)
@@ -119,6 +119,7 @@ Example:
- These **modules** combine **functions** that belong together in terms of functionality
This means, for example:
+
- There is the `unicado_python_library`, which contains, for example:
- the `pymodulepackage`, which includes:
- the `datapostprocessingmodule` and
@@ -136,15 +137,9 @@ This means, for example:
- Since it is common that a module contains several functions, explicit imports can be realized using the following syntax: `from mypythonmodule import easter_egg_hunt`.
# Code modularity (Python-only modules) {#code-modularity-python-only-modules}
-In the following, the modularized structure of a Python module is explained using the `cost_estimation` module. The according folder structure is shown in the following picture. It is also available for download.
-
-
+In the following, the modularized structure of a Python module is explained using the `cost_estimation` module. The according folder structure is shown in the following picture. It is also available for [download](https://git.rwth-aachen.de/unicado/unicado.gitlab.io/-/tree/develop/docs/get-involved/modularization/python-template).
-!!! warning
- Check, if images displayed correctly here!
-
-!!! warning
- Insert files here! {F216186}
+
## Layer example
The following **layers** are selected for cost calculation:
@@ -154,10 +149,7 @@ The following **layers** are selected for cost calculation:
3. Calculation method (e.g., `operating_cost_estimation_tu_berlin`, green folder)
4. Energy carrier (e.g., `kerosene` or `liquid_hydrogen`, grey folder) - **USER LAYER** (This is where the magic happens! :dizzy:)
-
-
-!!! warning
- Check, if images displayed correctly here!
+
## File structure
@@ -193,61 +185,50 @@ rAircraftDesign
<br>
!!! note
- [1] At the top level, the example structure distinguishes between aircraft configurations with two branches: **blended wing body** and **tube and wing**.
- [2] These folders are subdivided according to **layer 2** and may contain various calculation method fidelities.
- [3] This folder is subdivided according to **layer 3** and may contain various calculation methods.
+ [1] At the top level, the example structure distinguishes between aircraft configurations with two branches: **blended wing body** and **tube and wing**.<br>
+ [2] These folders are subdivided according to **layer 2** and may contain various calculation method fidelities.<br>
+ [3] This folder is subdivided according to **layer 3** and may contain various calculation methods.<br>
[4] This folder is subdivided according to **layer 4** and may contain various fuel types.
## Files that require changes by the module manager
The code is designed to be highly generalized, meaning that only a few files need changes by the module manager. These files are shown in the following image and are discussed below in more detail. In some parts of the code, dynamic import commands and function names are generated, with examples provided at relevant points to illustrate how these commands work.
-
-
-!!! warning
- Check, if images displayed correctly here!
+
### The `main()`
- Update the module name in two places within the docString
- Customize the module configuration file name
- Adjust the `runtime_output_string`
-
-
-
-!!! warning
- Check, if images displayed correctly here!
+
+
### The `data_preprocessing` (`datapreprocessing.py`)
- Update the layer description in the docString
- Customize the layer description within `layer_description_dict`. If a layer is unknown (e.g., `user_layer`), set it to 'None' rather than a path and call the relevant function (e.g., `read_energy_carrier`) as indicated (see lines 69 and following).
-
-
-
-!!! warning
- Check, if images displayed correctly here!
+
+
-**Example for `module_import_name`**
+**Example for `module_import_name`**
In this example, `module_import_name` at line 68 would be: `src.tube_and_wing.empirical.operating_cost_estimation_tu_berlin`.
-**Example for the import command**
-To import a module from `usermethoddatapreparation.py` at line 74, the command is as follows:
+**Example for the import command**
+To import a module from `usermethoddatapreparation.py` at line 74, the command is as follows:
`src.tube_and_wing.empirical.operating_cost_estimation_tu_berlin.usermethoddatapreparation`.
### The `data_postprocessing` (`datapostprocessing.py`)
- Modify `paths_to_key_parameters_list`
- Adjust `module_key_parameters_dict`
-
-
-
-!!! warning
- Check, if images displayed correctly here!
+
+
## Files that require changes by the user
Similarly, the code is structured so that only a few files require modifications by the user. These files are highlighted in the following image.
Note that this is an executable example code and a proposal for a structure. Generally speaking, the following files are at **user layer**:
+
- `methodexport.py`
- `methodplot.py`
- `methodreport.py`
@@ -258,10 +239,8 @@ Users are free to structure the code within these files but must ensure that all
More detailed instructions for required changes are available within the docStrings of each corresponding file.
-
+
-!!! warning
- Check, if images displayed correctly here!
# Logging and printing {#logging-and-printing}
The Python framework in this project has a customized logging function, which builds on Python’s [logging facility](https://docs.python.org/3/library/logging.html). The following logging levels are available:
@@ -275,7 +254,7 @@ The Python framework in this project has a customized logging function, which bu
| `runtime_output.error` | 40 | For serious issues where the code can still continue | `runtime_output.error("Error: Add some text here.")` |
| `runtime_output.critical` | 50 | For critical issues that terminate the code (exit code 1) | `runtime_output.critical("Error: Add some text here.")` |
-Instead of using Python's built-in `print` function, use these logging options to ensure all outputs are appropriately documented in the log file according to user settings.
+Instead of using Python's built-in `print` function, use these logging options to ensure all outputs are appropriately documented in the log file according to user settings.
## Logging configuration in the module configuration file
User settings for logging behavior can be configured in the module configuration file under `console_output/value` and `log_file_output/value`. The available modes are as follows:
@@ -291,6 +270,7 @@ Each mode enables progressively more detailed logging, from critical errors only
# Package generation {#package-generation}
Sources:
+
- [Python packaging](https://packaging.python.org/en/latest/tutorials/packaging-projects/)
- [Example video](https://www.youtube.com/watch?v=v6tALyc4C10&ab_channel=RealPython)
@@ -298,65 +278,58 @@ According to the UNICADO Python philosophy, the UNICADO Python library contains
The necessary steps are listed below. Please ensure to read the respective explanations of the individual steps carefully before proceeding to the next step.
**Prerequisites**
+
1. Update `pip` to the latest version:
- - **Unix/macOS:** `python3 -m pip install --upgrade pip`
- - **Windows:** `python -m pip install --upgrade pip`
+ - **Unix/macOS:** `python3 -m pip install --upgrade pip`
+ - **Windows:** `python -m pip install --upgrade pip`
2. Navigate to the `AircraftDesign/unicado_python_library` folder (illustrated below) to set up the required folder structure.
-
-
-!!! warning
- Check, if images displayed correctly here!
+
## Step 1: Create the package subfolder
In `unicado_python_library`, create a new subfolder for the package. Follow this naming convention:
+
- **Format:** `py[name of package]package` (all lowercase, without underscores)
- **Example:** `pymodulepackage`
-
+
Then, navigate into this subfolder.
## Step 2: Create a `pyproject.toml` file
The `pyproject.toml` file contains information on the build backend (`[build-system]`). We are using setuptools. Furthermore, this file contains core metadata for packaging-related tools to consume (`[project]`, `[project.urls]`).
-Please download the sample `pyproject.toml` file and complete the **highlighted fields** with package-specific information, without modifying build system details.
+Please see the sample `pyproject.toml` file in the example folder (that is available for [download](https://git.rwth-aachen.de/unicado/unicado.gitlab.io/-/tree/develop/docs/get-involved/modularization/python-template)) and complete the **highlighted fields** with package-specific information, without modifying build system details.
-!!! warning
- Upload files/images here! {F204735}
+
**Further resources:**
+
- [PEP 621: Project metadata](https://peps.python.org/pep-0621/)
- [Setuptools documentation](https://setuptools.pypa.io/en/latest/index.html)
## Step 3: Create a `LICENSE` file
-Add a `LICENSE` file to define usage rights. You can download this directly here:
-
-!!! warning
- Upload files/images here! {F204736}
- Add: This file only needs to be downloaded from the repository.
-
+Add a `LICENSE` file (it can be taken directly from the example folder) to define usage rights.
The [GPL-3.0 license](https://choosealicense.com/licenses/gpl-3.0/#) text is used in this example.
## Step 4: Create a `README.md` file
-Download and fill out the sample `README.md` file with details about your package. This file can also be obtained from the repository.
-
-!!! warning
- Upload files/images here! {F204737}
- Add: This file only needs to be downloaded from the repository.
+Download and fill out the sample `README.md` file with details about your package. This file can also be obtained from example folder in the repository.
## Step 5: Create `src` subfolder
Inside the package folder, create a `src` subfolder to hold the `.py` files (modules).
-- **Convention:** Each `.py` file should correspond to a single module, named in this format:
- - **Format:** `[module name]module.py` (all lowercase, no underscores)
- - **Example:** `datapreprocessingmodule.py`
+- **Convention:** Each `.py` file should correspond to a single module, named in this format:
+ - **Format:** `[module name]module.py` (all lowercase, no underscores)
+ - **Example:** `datapreprocessingmodule.py`
+
Modules can contain several functions. Once files are set up, return to the main package folder before proceeding.
## Step 6: Execute installation command
In the directory containing `pyproject.toml`, run the following installation command:
+
- **Windows:** `python -m pip install -e .`
- **macOS:** `python3 -m pip install -e .`
**Explanation:**
+
- **`-m` flag:** Specifies the module to run as a script.
- **`-e` (editable mode):** Installs the package in editable mode, meaning changes to source code are immediately reflected.
@@ -372,4 +345,4 @@ The modules should now be ready to use. You can import the functions from the m
`from datapostprocessingmodule import paths_and_names`
# Testing with Python {#testing-with-python}
-tbd. :construction:
+tbd. :construction:
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/CMakeLists.txt b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/CMakeLists.txt
new file mode 100644
index 0000000..b9ce402
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/CMakeLists.txt
@@ -0,0 +1,80 @@
+
+# Set name of executable
+set(MODULE_NAME docEstimation)
+
+# ==============================================
+# Add the module executable
+#
+# *** IMPORTANT ***
+# -> Change *.cpp files according to the module
+# -> Add main.cpp later since this list is also
+# used for the tests
+# ==============================================
+
+# Fuel - Fossil
+set(MODULE_SOURCES_FOSSIL
+ src/fossil/lowFidelity/lowFossil.cpp
+ src/fossil/lowFidelity/lowFossilIOData.cpp
+ src/fossil/lowFidelity/lowFossilReport.cpp
+ src/fossil/lowFidelity/lowFossilPlot.cpp
+)
+
+# Fuel - H2
+set(MODULE_SOURCES_H2
+ src/h2/lowFidelity/lowH2.cpp
+ src/h2/lowFidelity/lowH2IOData.cpp
+ src/h2/lowFidelity/lowH2Report.cpp
+ src/h2/lowFidelity/lowH2Plot.cpp
+)
+
+set(MODULE_SOURCES
+ ${MODULE_SOURCES_FOSSIL}
+ ${MODULE_SOURCES_H2}
+ src/tankDesign.cpp
+)
+
+add_executable(${MODULE_NAME}
+ ${MODULE_SOURCES}
+ src/mainTankDesign.cpp
+)
+
+
+# Set compile options specific to this module
+if(USE_GNUPLOT)
+ # -> Bug: When not setting this option, the `generateSvgPlot` is not overwritten by calculatePolarOutput.cpp
+ target_compile_definitions(${MODULE_NAME} PRIVATE USE_GNUPLOT)
+endif()
+
+
+# Link the runtime libraries
+target_link_libraries(${MODULE_NAME}
+ PRIVATE
+ moduleBasics
+ strategy
+ runtimeInfo
+ aixml
+ standardFiles
+ svl
+ svgPlot
+ spline
+ aircraftGeometry
+)
+
+# Add the include directories
+target_include_directories(${MODULE_NAME}
+ PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/.. # <- This is due to the includes in the main file # <- This is due to the absolute import in svl/svl/Basics.h
+ PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/src/ # <- This is due to the includes in empennage
+ PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/src/common/
+ PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/src/h2/
+ PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/src/fossil/
+)
+
+# Set the location where the executable will be placed to the current source directory
+set_target_properties(${MODULE_NAME} PROPERTIES
+ RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+)
+
+# Add the tests if enabled
+if(BUILD_UNITTEST)
+ add_subdirectory(test)
+endif()
\ No newline at end of file
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/Icon\r"
new file mode 100644
index 0000000..e69de29
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation.log b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation.log
new file mode 100644
index 0000000..7699eab
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation.log
@@ -0,0 +1,117 @@
+2024-02-13 09:04:07,608 - PRINT - Operating cost estimation started...
+2024-02-13 09:04:07,652 - PRINT - ----------------------------------------------------------
+2024-02-13 09:04:07,653 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-02-13 09:04:07,653 - PRINT - ----------------------------------------------------------
+2024-02-13 09:04:07,702 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
+2024-02-13 09:04:07,702 - PRINT - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
+2024-02-13 09:04:07,709 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
+2024-02-13 09:04:07,710 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
+2024-02-13 09:04:07,710 - PRINT - Operating cost estimation finished.
+2024-02-13 09:12:29,973 - PRINT - Operating cost estimation started...
+2024-02-13 09:12:30,029 - PRINT - ----------------------------------------------------------
+2024-02-13 09:12:30,029 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-02-13 09:12:30,029 - PRINT - ----------------------------------------------------------
+2024-02-13 09:12:30,076 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
+2024-02-13 09:12:30,077 - PRINT - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
+2024-02-13 09:12:30,084 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
+2024-02-13 09:12:30,088 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
+2024-02-13 09:12:30,089 - PRINT - Operating cost estimation finished.
+2024-02-13 09:56:53,711 - PRINT - Operating cost estimation started...
+2024-02-13 09:56:53,731 - PRINT - ----------------------------------------------------------
+2024-02-13 09:56:53,732 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-02-13 09:56:53,732 - PRINT - ----------------------------------------------------------
+2024-02-13 09:56:53,755 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
+2024-02-13 09:56:53,755 - PRINT - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
+2024-02-13 09:56:53,758 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
+2024-02-13 09:56:53,759 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
+2024-02-13 09:56:53,759 - PRINT - Operating cost estimation finished.
+2024-02-13 10:21:47,825 - PRINT - Operating cost estimation started...
+2024-02-13 10:21:47,839 - PRINT - ----------------------------------------------------------
+2024-02-13 10:21:47,839 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-02-13 10:21:47,839 - PRINT - ----------------------------------------------------------
+2024-02-13 10:21:47,862 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
+2024-02-13 10:21:47,862 - PRINT - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
+2024-02-13 10:21:47,865 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
+2024-02-13 10:21:47,866 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
+2024-02-13 10:21:47,866 - PRINT - Operating cost estimation finished.
+2024-02-13 10:51:25,723 - PRINT - Operating cost estimation started...
+2024-02-13 10:51:25,737 - PRINT - ----------------------------------------------------------
+2024-02-13 10:51:25,738 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-02-13 10:51:25,738 - PRINT - ----------------------------------------------------------
+2024-02-13 10:51:25,760 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
+2024-02-13 10:51:25,761 - PRINT - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
+2024-02-13 10:51:25,763 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
+2024-02-13 10:51:25,764 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
+2024-02-13 10:51:25,764 - PRINT - Operating cost estimation finished.
+2024-06-19 10:13:51,184 - PRINT - Operating cost estimation started...
+2024-06-19 10:13:51,188 - PRINT - ----------------------------------------------------------
+2024-06-19 10:13:51,189 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-06-19 10:13:51,189 - PRINT - ----------------------------------------------------------
+2024-06-19 10:13:51,194 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
+2024-06-19 10:13:51,194 - WARNING - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
+2024-06-19 10:13:51,196 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
+2024-06-19 10:13:51,196 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
+2024-06-19 10:13:51,196 - PRINT - Operating cost estimation finished.
+2024-06-19 10:15:37,122 - PRINT - Operating cost estimation started...
+2024-06-19 10:15:37,125 - PRINT - ----------------------------------------------------------
+2024-06-19 10:15:37,125 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-06-19 10:15:37,126 - PRINT - ----------------------------------------------------------
+2024-06-19 10:15:37,126 - CRITICAL - KeyError: 'operating_cost_estimation_tu_berlin'
+ Main execution of cost estimation module failed!
+ Program aborted.
+2024-06-19 10:32:57,451 - PRINT - Operating cost estimation started...
+2024-06-19 10:32:57,455 - PRINT - ----------------------------------------------------------
+2024-06-19 10:32:57,455 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-06-19 10:32:57,455 - PRINT - ----------------------------------------------------------
+2024-06-19 10:32:57,455 - CRITICAL - TypeError: prepare_element_tree_for_module_key_parameter() takes 2 positional arguments but 3 were given
+ Main execution of cost estimation module failed!
+ Program aborted.
+2024-06-19 10:39:01,575 - PRINT - Operating cost estimation started...
+2024-06-19 10:39:01,579 - PRINT - ----------------------------------------------------------
+2024-06-19 10:39:01,579 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-06-19 10:39:01,579 - PRINT - ----------------------------------------------------------
+2024-06-19 10:39:01,585 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
+2024-06-19 10:39:01,585 - WARNING - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
+2024-06-19 10:39:01,587 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
+2024-06-19 10:39:01,587 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
+2024-06-19 10:39:01,587 - PRINT - Operating cost estimation finished.
+2024-06-19 10:41:59,058 - PRINT - Operating cost estimation started...
+2024-06-19 10:43:24,962 - PRINT - Operating cost estimation started...
+2024-06-19 10:43:24,968 - PRINT - ----------------------------------------------------------
+2024-06-19 10:43:24,968 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-06-19 10:43:24,968 - PRINT - ----------------------------------------------------------
+2024-06-19 10:43:24,974 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
+2024-06-19 10:43:24,974 - WARNING - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
+2024-06-19 10:43:24,975 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
+2024-06-19 10:43:24,976 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
+2024-06-19 10:43:24,976 - PRINT - Operating cost estimation finished.
+2024-11-18 10:46:15,464 - PRINT - Cost estimation started...
+2024-11-18 10:46:15,467 - PRINT - ----------------------------------------------------------
+2024-11-18 10:46:15,468 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-11-18 10:46:15,468 - PRINT - ----------------------------------------------------------
+2024-11-18 10:46:15,473 - CRITICAL - AttributeError:
+ - File : datapostprocessingmodule.py
+ - Function / Method: method_data_postprocessing
+ - Line : 740
+ - Code : html_switch = eval(root_of_module_config_tree.find('.//report_output/value').text.capitalize())
+ - Error message : 'NoneType' object has no attribute 'text'
+Main execution of cost estimation module failed!
+Program aborted.
+2024-11-18 10:47:45,414 - PRINT - Cost estimation started...
+2024-11-18 10:47:45,418 - PRINT - ----------------------------------------------------------
+2024-11-18 10:47:45,418 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-11-18 10:47:45,418 - PRINT - ----------------------------------------------------------
+2024-11-18 10:47:45,423 - PRINT - Warning: No "method_plot" function in "methodplot.py" file implemented yet.
+2024-11-18 10:47:45,423 - WARNING - Warning: "html_output" switch in module configuration file set to "False". No HTML report generated.
+2024-11-18 10:47:45,424 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
+2024-11-18 10:47:45,425 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
+2024-11-18 10:47:45,425 - PRINT - Operating cost estimation finished.
+2024-11-18 10:48:55,251 - PRINT - Cost estimation started...
+2024-11-18 10:48:55,255 - PRINT - ----------------------------------------------------------
+2024-11-18 10:48:55,255 - PRINT - [No method implemented yet ("methodkerosene.py").]
+2024-11-18 10:48:55,255 - PRINT - ----------------------------------------------------------
+2024-11-18 10:48:55,260 - PRINT - Warning: No "method_plot" function in "methodplot.py" file implemented yet.
+2024-11-18 10:48:55,260 - WARNING - Warning: "html_output" switch in module configuration file set to "False". No HTML report generated.
+2024-11-18 10:48:55,261 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
+2024-11-18 10:48:55,261 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
+2024-11-18 10:48:55,261 - PRINT - Operating cost estimation finished.
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation_conf.xml b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation_conf.xml
new file mode 100644
index 0000000..5c78866
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation_conf.xml
@@ -0,0 +1,311 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+ <module_configuration_file Name="Cost Estimation Runtime Configuration"> <!-- Change naming according to module name -->
+ <control_settings description="General control settings for this tool">
+ <aircraft_exchange_file_name description="Specify the name of the exchange file">
+ <value>CSR-02.xml</value>
+ </aircraft_exchange_file_name>
+ <aircraft_exchange_file_directory description="Specify the direction in which the aircraft exchange file can be found">
+ <value>./projects/CSR/CSR-02/</value>
+ </aircraft_exchange_file_directory>
+ <own_tool_level description="Specify the tool level of this tool">
+ <value>2</value>
+ </own_tool_level>
+ <console_output description="Selector to specify the console output. Selector: mode_0 (Off) / mode_1 (only out/err/warn) / mode_2 (1 + info) / mode_3 (2 + debug)">
+ <value>mode_1</value>
+ </console_output>
+ <log_file_output description="Selector to specify the log file output. Selector: mode_0 (Off) / mode_1 (only out/err/warn) / mode_2 (1 + info) / mode_3 (2 + debug)">
+ <value>mode_1</value>
+ </log_file_output>
+ <plot_output description="Specify the way plotting shall be handled">
+ <enable description="Switch to enable plotting. Switch: true (On) / false (Off)">
+ <value>true</value>
+ </enable>
+ <copy_plotting_files description="Switch if plotting files shall be copied. Switch: true (On) / false (Off)">
+ <value>true</value>
+ </copy_plotting_files>
+ <delete_plotting_files_from_tool_folder description="Switch if plotting files shall be deleted from folder. Switch: true (On) / false (Off)">
+ <value>true</value>
+ </delete_plotting_files_from_tool_folder>
+ </plot_output>
+ <report_output description="Switch to generate an HTML report. Switch: true (On) / false (Off)">
+ <value>false</value>
+ </report_output>
+ <tex_report description="Switch to generate a Tex report. Switch: true (On) / false (Off)">
+ <value>false</value>
+ </tex_report>
+ <write_info_files description="Switch to generate info files. Switch: true (On) / false (Off)">
+ <value>false</value>
+ </write_info_files>
+ <log_file description="Specify the name of the log file">
+ <value>cost_estimation.log</value>
+ </log_file>
+ <inkscape_path description="Path to the inkscape application (DEFAULT: Use inkscape from the UNICADO repo structure)">
+ <value>DEFAULT</value>
+ </inkscape_path>
+ <gnuplot_path description="Path to the gnuplot application (DEFAULT: Use gnuplot from the UNICADO repo structure)">
+ <value>DEFAULT</value>
+ </gnuplot_path>
+ <program_specific_control_settings description="Program specific control settings for this tool">
+ <xml_output description="Switch to export module specific data to XML ('true': On, 'false': Off)">
+ <value>true</value>
+ </xml_output>
+ </program_specific_control_settings>
+ </control_settings>
+ <program_settings description="program settings">
+ <configuration ID="tube_and_wing">
+ <fidelity_name description="Select fidelity name (options: empirical, numerical,...)">
+ <value>empirical</value>
+ </fidelity_name>
+ <method_name description="Select method name (options: operating_cost_estimation_tu_berlin)">
+ <value>operating_cost_estimation_tu_berlin</value>
+ <default>operating_cost_estimation_tu_berlin</default>
+ </method_name>
+ <fidelity ID="empirical">
+ <operating_cost_estimation_tu_berlin description="Empirical method to estimate the direct operating costs (DOC) and indirect operating costs (IOC) of an aircraft.">
+ <general_direct_operating_costs_parameter>
+ <capital description="Capital cost related parameters">
+ <depreciation_period description="Depreciation period (assumption for default value: depreciation to 15% residual value in 12 years)">
+ <value>12.0</value>
+ <unit>y</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>30.0</upper_boundary>
+ <default>12.0</default>
+ </depreciation_period>
+ <price_per_operating_empty_mass description="Price per kg operating empty mass">
+ <value>1245.0</value>
+ <unit>EUR/kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>1245.0</default>
+ </price_per_operating_empty_mass>
+ <rate_insurance description="Insurance rate">
+ <value>0.005</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ <default>0.005</default>
+ </rate_insurance>
+ <rate_interest description="Interest rate">
+ <value>0.05</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ <default>0.05</default>
+ </rate_interest>
+ <residual_value_factor description="Residual value per aircraft price after depreciation period">
+ <value>0.15</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>20.0</upper_boundary>
+ <default>0.15</default>
+ </residual_value_factor>
+ </capital>
+ <crew description="Crew cost related parameters">
+ <salary_variation description="Salary variation mode (0: same salary for design mission and mission study, 1: range dependent salaries)">
+ <value>0</value>
+ <default>0</default>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </salary_variation>
+ </crew>
+ <flight_cycles description="Flight cycle related parameters">
+ <block_time_per_flight description="Average block time supplement per flight (default: 1.83 h)" Unit="hours" Default="1.83" lower_boundary="0" upper_boundary="None">
+ <value>1.83</value>
+ <unit>h</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>1.83</default>
+ </block_time_per_flight>
+ <daily_night_curfew_time description="Night curfew time per day">
+ <value>7.0</value>
+ <unit>h</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>7.0</default>
+ </daily_night_curfew_time>
+ <potential_annual_operation_time description="Potential annual operation time (365 days a 24h hours)">
+ <value>8760</value>
+ <unit>h</unit>
+ <lower_boundary>8760</lower_boundary>
+ <upper_boundary>8784</upper_boundary>
+ <default>8760</default>
+ </potential_annual_operation_time>
+ <annual_lay_days_overhaul description="Lay days per year for overhaul (D-Check every 5 years a 4 weeks)">
+ <value>5.6</value>
+ <unit>day</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>5.6</default>
+ </annual_lay_days_overhaul>
+ <annual_lay_days_reserve description="Lay days per year for repairs, technical and operational reserve (statistical value)">
+ <value>2.6</value>
+ <unit>day</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>2.6</default>
+ </annual_lay_days_reserve>
+ </flight_cycles>
+ <handling description="Handling related parameters">
+ <fees_handling description="Handling fees per kg payload">
+ <value>0.1</value>
+ <unit>EUR/kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>0.1</default>
+ </fees_handling>
+ </handling>
+ <landing description="Landing related parameters">
+ <fees_landing description="Landing fees per kg maximum take-off mass">
+ <value>0.01</value>
+ <unit>EUR/kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>0.01</default>
+ </fees_landing>
+ </landing>
+ <air_traffic_control description="Air traffic control related parameters">
+ <air_traffic_control_price_factor_design description="Range dependent ATC price factor for design mission (range dependent: domestic europe 1.0, transatlantic 0.7, far east flights half of landings @ european airports 0.6)">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.6</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ <default>1.0</default>
+ </air_traffic_control_price_factor_design>
+ <air_traffic_control_price_factor_study description="range dependent ATC price factor for mission study (range dependent: domestic europe 1.0, transatlantic 0.7, far east flights half of landings @ european airports 0.6)">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.6</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ <default>1.0</default>
+ </air_traffic_control_price_factor_study>
+ </air_traffic_control>
+ <maintenance description="Maintenance related parameters">
+ <airframe_repair_costs_per_flight description="Airframe repair costs per flight">
+ <value>57.5</value>
+ <unit>EUR</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>57.5</default>
+ </airframe_repair_costs_per_flight>
+ <annual_lay_days_maintenance description="Lay days per year for maintenance (C-Check every 15 month a 4 days)">
+ <value>3.2</value>
+ <unit>day</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>3.2</default>
+ </annual_lay_days_maintenance>
+ <cost_burden description="Cost burden maintenance">
+ <value>10.5</value>
+ <unit>EUR</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>10.5</default>
+ </cost_burden>
+ <rate_labor description="Labor rate">
+ <value>50.0</value>
+ <unit>EUR/h</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>50.0</default>
+ </rate_labor>
+ </maintenance>
+ <related_direct_operating_costs description="Necessary parameters for the calculation of related DOC">
+ <revenue_per_freight_km_design description="Revenue per flight kilometer design mission">
+ <value>0.2</value>
+ <unit>EUR/kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>0.2</default>
+ </revenue_per_freight_km_design>
+ <revenue_per_freight_km_study description="Revenue per flight kilometer mission study">
+ <value>0.2</value>
+ <unit>EUR/kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>0.2</default>
+ </revenue_per_freight_km_study>
+ </related_direct_operating_costs>
+ <miscellaneous description="Miscellaneous parameters">
+ <rate_inflation description="Rate of annual inflation (including price and salary increases)">
+ <value>0.03</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>0.03</default>
+ </rate_inflation>
+ <seat_load_factor_design description="Seat load factor of design mission">
+ <value>0.85</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ <default>0.85</default>
+ </seat_load_factor_design>
+ <seat_load_factor_study description="Seat load factor of study mission">
+ <value>0.85</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ <default>0.85</default>
+ </seat_load_factor_study>
+ </miscellaneous>
+ </general_direct_operating_costs_parameter>
+ <fuel_type ID="kerosene">
+ <factor_engine_maintenance description="Factor for engine maintenance">
+ <value>1</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>1</default>
+ </factor_engine_maintenance>
+ <fuel_price description="Average fuel price per kg kerosene">
+ <value>0.7</value>
+ <unit>EUR/kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>0.7</default>
+ </fuel_price>
+ <ratio_operating_empty_mass description="Ratio of operating empty mass kerosene aircraft to hydrogen aircraft">
+ <value>1</value>
+ <unit>EUR</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>1</default>
+ </ratio_operating_empty_mass>
+ </fuel_type>
+ <fuel_type ID="liquid_hydrogen">
+ <factor_engine_maintenance description="Factor for engine maintenance">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>1</default>
+ </factor_engine_maintenance>
+ <fuel_price description="Average fuel price per kg liquid hydrogen">
+ <value>9.16</value>
+ <unit>EUR/kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>9.16</default>
+ </fuel_price>
+ <ratio_operating_empty_mass description="Ratio of operating empty mass kerosene aircraft to hydrogen aircraft">
+ <value>1.1</value>
+ <unit>EUR</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>1.1</default>
+ </ratio_operating_empty_mass>
+ </fuel_type>
+ <fuel_type ID="gaseous_hydrogen">
+ <fuel_price description="Average fuel price per kg gaseous hydrogen">
+ <value>12.85</value>
+ <unit>EUR/kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <default>12.85</default>
+ </fuel_price>
+ </fuel_type>
+ </operating_cost_estimation_tu_berlin>
+ </fidelity>
+ </configuration>
+ </program_settings>
+ </module_configuration_file>
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/Doxyfile b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/Doxyfile
new file mode 100644
index 0000000..1576c5a
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/Doxyfile
@@ -0,0 +1,2824 @@
+# Doxyfile 1.9.8
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
+#
+# Note:
+#
+# Use doxygen to compare the used configuration file with the template
+# configuration file:
+# doxygen -x [configFile]
+# Use doxygen to compare the used configuration file with the template
+# configuration file without replacing the environment variables or CMake type
+# replacement variables:
+# doxygen -x_noenv [configFile]
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the configuration
+# file that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
+# The default value is: UTF-8.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
+
+PROJECT_NAME = "cost_estimation"
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
+
+PROJECT_NUMBER =
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF =
+
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
+
+PROJECT_LOGO =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = .
+
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
+# sub-directories (in 2 levels) under the output directory of each output format
+# and will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
+# control the number of sub-directories.
+# The default value is: NO.
+
+CREATE_SUBDIRS = NO
+
+# Controls the number of sub-directories that will be created when
+# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
+# level increment doubles the number of directories, resulting in 4096
+# directories at level 8 which is the default and also the maximum value. The
+# sub-directories are organized in 2 levels, the first level always has a fixed
+# number of 16 directories.
+# Minimum value: 0, maximum value: 8, default value: 8.
+# This tag requires that the tag CREATE_SUBDIRS is set to YES.
+
+CREATE_SUBDIRS_LEVEL = 8
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
+# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
+# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
+# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
+# English messages), Korean, Korean-en (Korean with English messages), Latvian,
+# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
+# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
+# Swedish, Turkish, Ukrainian and Vietnamese.
+# The default value is: English.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+# The default value is: YES.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
+
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# doxygen will generate a detailed section even if there is only a brief
+# description.
+# The default value is: NO.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
+
+FULL_PATH_NAMES = YES
+
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
+# such as
+# /***************
+# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
+# Javadoc-style will behave just like regular comments and it will not be
+# interpreted by doxygen.
+# The default value is: NO.
+
+JAVADOC_BANNER = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# By default Python docstrings are displayed as preformatted text and doxygen's
+# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
+# doxygen's special commands can be used and the contents of the docstring
+# documentation blocks is shown as doxygen documentation.
+# The default value is: YES.
+
+PYTHON_DOCSTRING = YES
+
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
+# page for each member. If set to NO, the documentation of a member will be part
+# of the file/class/namespace that contains it.
+# The default value is: NO.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 4
+
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:^^"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". Note that you cannot put \n's in the value part of an alias
+# to insert newlines (in the resulting output). You can put ^^ in the value part
+# of an alias to insert a newline as if a physical newline was in the original
+# file. When you need a literal { or } or , in the value part of an alias you
+# have to escape them by means of a backslash (\), this can lead to conflicts
+# with the commands \{ and \} for these it is advised to use the version @{ and
+# @} or use a double escape (\\{ and \\})
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
+# sources only. Doxygen will then generate output that is more tailored for that
+# language. For instance, namespaces will be presented as modules, types will be
+# separated into more groups, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_SLICE = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
+# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
+# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
+# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
+# tries to guess whether the code is fixed or free formatted code, this is the
+# default for Fortran type files). For instance to make doxygen treat .inc files
+# as Fortran files (default is PHP), and .f files as C (default is Fortran),
+# use: inc=Fortran f=C.
+#
+# Note: For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen. When specifying no_extension you should add
+# * to the FILE_PATTERNS.
+#
+# Note see also the list of default file extension mappings.
+
+EXTENSION_MAPPING =
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See https://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT = YES
+
+# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
+# to that level are automatically included in the table of contents, even if
+# they do not have an id attribute.
+# Note: This feature currently applies only to Markdown headings.
+# Minimum value: 0, maximum value: 99, default value: 5.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+TOC_INCLUDE_HEADINGS = 5
+
+# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
+# generate identifiers for the Markdown headings. Note: Every identifier is
+# unique.
+# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
+# sequence number starting at 0 and GITHUB use the lower case version of title
+# with any whitespace replaced by '-' and punctuation characters removed.
+# The default value is: DOXYGEN.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+MARKDOWN_ID_STYLE = DOXYGEN
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+# The default value is: NO.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# If one adds a struct or class to a group and this option is enabled, then also
+# any nested class or struct is added to the same group. By default this option
+# is disabled and one has to add nested compounds explicitly via \ingroup.
+# The default value is: NO.
+
+GROUP_NESTED_COMPOUNDS = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = NO
+
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_CACHE_SIZE = 0
+
+# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
+# during processing. When set to 0 doxygen will based this on the number of
+# cores available in the system. You can set it explicitly to a value larger
+# than 0 to get more control over the balance between CPU load and processing
+# speed. At this moment only the input processing can be done using multiple
+# threads. Since this is still an experimental feature the default is set to 1,
+# which effectively disables parallel processing. Please report any issues you
+# encounter. Generating dot graphs in parallel is controlled by the
+# DOT_NUM_THREADS setting.
+# Minimum value: 0, maximum value: 32, default value: 1.
+
+NUM_PROC_THREADS = 1
+
+# If the TIMESTAMP tag is set different from NO then each generated page will
+# contain the date or date and time when the page was generated. Setting this to
+# NO can help when comparing the output of multiple runs.
+# Possible values are: YES, NO, DATETIME and DATE.
+# The default value is: NO.
+
+TIMESTAMP = NO
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIVATE = YES
+
+# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
+# methods of a class will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIV_VIRTUAL = YES
+
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE = YES
+
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
+
+EXTRACT_STATIC = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO,
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. If set to YES, local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO, only methods in the interface are
+# included.
+# The default value is: NO.
+
+EXTRACT_LOCAL_METHODS = YES
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
+
+EXTRACT_ANON_NSPACES = YES
+
+# If this flag is set to YES, the name of an unnamed parameter in a declaration
+# will be determined by the corresponding definition. By default unnamed
+# parameters remain unnamed in the output.
+# The default value is: YES.
+
+RESOLVE_UNNAMED_PARAMS = YES
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO, these classes will be included in the various overviews. This option
+# will also hide undocumented C++ concepts if enabled. This option has no effect
+# if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# declarations. If set to NO, these declarations will be included in the
+# documentation.
+# The default value is: NO.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+INTERNAL_DOCS = NO
+
+# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
+# able to match the capabilities of the underlying filesystem. In case the
+# filesystem is case sensitive (i.e. it supports files in the same directory
+# whose names only differ in casing), the option must be set to YES to properly
+# deal with such files in case they appear in the input. For filesystems that
+# are not case sensitive the option should be set to NO to properly deal with
+# output files written for symbols that only differ in casing, such as for two
+# classes, one named CLASS and the other named Class, and to also support
+# references to files without having to specify the exact matching casing. On
+# Windows (including Cygwin) and MacOS, users should typically set this option
+# to NO, whereas on Linux or other Unix flavors it should typically be set to
+# YES.
+# Possible values are: SYSTEM, NO and YES.
+# The default value is: SYSTEM.
+
+CASE_SENSE_NAMES = SYSTEM
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
+# will show which file needs to be included to use the class.
+# The default value is: YES.
+
+SHOW_HEADERFILE = YES
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order.
+# The default value is: YES.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
+# list. This list is created by putting \todo commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
+# list. This list is created by putting \test commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have for it to appear in the
+# documentation. If the initializer consists of more lines than specified here
+# it will be hidden. Use a value of 0 to hide initializers completely. The
+# appearance of the value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
+# the bottom of the documentation of classes and structs. If set to YES, the
+# list will mention the files that were used to generate the documentation.
+# The default value is: YES.
+
+SHOW_USED_FILES = YES
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file. See also section "Changing the
+# layout of pages" for information.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
+
+LAYOUT_FILE =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
+
+CITE_BIB_FILES = literature.bib
+
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
+
+WARNINGS = YES
+
+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as documenting some parameters in
+# a documented function twice, or documenting parameters that don't exist or
+# using markup commands wrongly.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR = YES
+
+# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
+# function parameter documentation. If set to NO, doxygen will accept that some
+# parameters have no documentation without warning.
+# The default value is: YES.
+
+WARN_IF_INCOMPLETE_DOC = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong parameter
+# documentation, but not about the absence of documentation. If EXTRACT_ALL is
+# set to YES then this flag will automatically be disabled. See also
+# WARN_IF_INCOMPLETE_DOC
+# The default value is: NO.
+
+WARN_NO_PARAMDOC = NO
+
+# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
+# undocumented enumeration values. If set to NO, doxygen will accept
+# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: NO.
+
+WARN_IF_UNDOC_ENUM_VAL = NO
+
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
+# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
+# at the end of the doxygen process doxygen will return with a non-zero status.
+# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves
+# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
+# write the warning messages in between other messages but write them at the end
+# of a run, in case a WARN_LOGFILE is defined the warning messages will be
+# besides being in the defined file also be shown at the end of a run, unless
+# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
+# the behavior will remain as with the setting FAIL_ON_WARNINGS.
+# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
+# The default value is: NO.
+
+WARN_AS_ERROR = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# See also: WARN_LINE_FORMAT
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# In the $text part of the WARN_FORMAT command it is possible that a reference
+# to a more specific place is given. To make it easier to jump to this place
+# (outside of doxygen) the user can define a custom "cut" / "paste" string.
+# Example:
+# WARN_LINE_FORMAT = "'vi $file +$line'"
+# See also: WARN_FORMAT
+# The default value is: at line $line of file $file.
+
+WARN_LINE_FORMAT = "at line $line of file $file"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr). In case the file specified cannot be opened for writing the
+# warning and error messages are written to standard error. When as file - is
+# specified the warning and error messages are written to standard output
+# (stdout).
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
+# Note: If this tag is empty the current directory is searched.
+
+INPUT = ../src/ ./content/
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see:
+# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
+# See also: INPUT_FILE_ENCODING
+# The default value is: UTF-8.
+
+INPUT_ENCODING = UTF-8
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
+# character encoding on a per file pattern basis. Doxygen will compare the file
+# name with each pattern and apply the encoding instead of the default
+# INPUT_ENCODING) if there is a match. The character encodings are a list of the
+# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
+# "INPUT_ENCODING" for further information on supported encodings.
+
+INPUT_FILE_ENCODING =
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# read by doxygen.
+#
+# Note the list of default checked file patterns might differ from the list of
+# default file extension mappings.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
+# *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl,
+# *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php,
+# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be
+# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
+# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
+
+FILE_PATTERNS = *.c \
+ *.cc \
+ *.cxx \
+ *.cxxm \
+ *.cpp \
+ *.cppm \
+ *.c++ \
+ *.c++m \
+ *.java \
+ *.ii \
+ *.ixx \
+ *.ipp \
+ *.i++ \
+ *.inl \
+ *.idl \
+ *.ddl \
+ *.odl \
+ *.h \
+ *.hh \
+ *.hxx \
+ *.hpp \
+ *.h++ \
+ *.ixx \
+ *.l \
+ *.cs \
+ *.d \
+ *.php \
+ *.php4 \
+ *.php5 \
+ *.phtml \
+ *.inc \
+ *.m \
+ *.markdown \
+ *.md \
+ *.mm \
+ *.dox \
+ *.py \
+ *.pyw \
+ *.f90 \
+ *.f95 \
+ *.f03 \
+ *.f08 \
+ *.f18 \
+ *.f \
+ *.for \
+ *.vhd \
+ *.vhdl \
+ *.ucf \
+ *.qsf \
+ *.ice
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
+RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+# The default value is: NO.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# ANamespace::AClass, ANamespace::*Test
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS = *
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
+
+IMAGE_PATH = ./img/
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+#
+# Note that doxygen will use the data processed and written to standard output
+# for further processing, therefore nothing else, like debug statements or used
+# commands (so in case of a Windows batch file always use @echo OFF), should be
+# written to standard output.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
+
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE =
+
+# The Fortran standard specifies that for fixed formatted Fortran code all
+# characters from position 72 are to be considered as comment. A common
+# extension is to allow longer lines before the automatic comment starts. The
+# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
+# be processed before the automatic comment starts.
+# Minimum value: 7, maximum value: 10000, default value: 72.
+
+FORTRAN_COMMENT_AFTER = 72
+
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# entity all documented functions referencing it will be listed.
+# The default value is: NO.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES then for each documented function
+# all documented entities called/used by that function will be listed.
+# The default value is: NO.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
+# to YES then the hyperlinks from functions in REFERENCES_RELATION and
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
+# link to the documentation.
+# The default value is: YES.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code will
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
+# source browser. The htags tool is part of GNU's global source tagging system
+# (see https://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
+# verbatim copy of the header file for each class for which an include is
+# specified. Set to NO to disable this.
+# See also: Section \class.
+# The default value is: YES.
+
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX = YES
+
+# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
+# that should be ignored while generating the index headers. The IGNORE_PREFIX
+# tag works for classes, function and member names. The entity will be placed in
+# the alphabetical list under the first letter of the entity name that remains
+# after removing the prefix.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_OUTPUT = cost_estimation
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER = header.html
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# Note: Since the styling of scrollbars can currently not be overruled in
+# Webkit/Chromium, the styling will be left out of the default doxygen.css if
+# one or more extra stylesheets have been specified. So if scrollbar
+# customization is desired it has to be added explicitly. For an example see the
+# documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET = ../../libs/extern/doxygen-awesome-css/doxygen-awesome.css
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES = ../../libs/extern/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js\
+ ../../libs/extern/doxygen-awesome-css/doxygen-awesome-tabs.js\
+ ../../libs/extern/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js
+
+# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
+# should be rendered with a dark or light theme.
+# Possible values are: LIGHT always generate light mode output, DARK always
+# generate dark mode output, AUTO_LIGHT automatically set the mode according to
+# the user preference, use light mode if no preference is set (the default),
+# AUTO_DARK automatically set the mode according to the user preference, use
+# dark mode if no preference is set and TOGGLE allow to user to switch between
+# light and dark mode via a button.
+# The default value is: AUTO_LIGHT.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE = LIGHT
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a color-wheel, see
+# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use gray-scales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
+# documentation will contain a main index with vertical navigation menus that
+# are dynamically created via JavaScript. If disabled, the navigation index will
+# consists of multiple levels of tabs that are statically embedded in every HTML
+# page. Disable this option to support browsers that do not have JavaScript,
+# like the Qt help browser.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_MENUS = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
+# dynamically folded and expanded in the generated HTML source code.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_CODE_FOLDING = YES
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see:
+# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
+# create a documentation set, doxygen will generate a Makefile in the HTML
+# output directory. Running make will produce the docset in that directory and
+# running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
+# genXcode/_index.html for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_DOCSET = NO
+
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# This tag determines the URL of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDURL =
+
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# on Windows. In the beginning of 2021 Microsoft took the original page, with
+# a.o. the download links, offline the HTML help workshop was already many years
+# in maintenance mode). You can download the HTML help workshop from the web
+# archives at Installation executable (see:
+# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
+# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP = NO
+
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
+# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_FILE =
+
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler (hhc.exe). If non-empty,
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+HHC_LOCATION =
+
+# The GENERATE_CHI flag controls if a separate .chi index file is generated
+# (YES) or that it should be included in the main .chm file (NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+GENERATE_CHI = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_INDEX_ENCODING =
+
+# The BINARY_TOC flag controls whether a binary table of contents is generated
+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+TOC_EXPAND = NO
+
+# The SITEMAP_URL tag is used to specify the full URL of the place where the
+# generated documentation will be placed on the server by the user during the
+# deployment of the documentation. The generated sitemap is called sitemap.xml
+# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
+# is specified no sitemap is generated. For information about the sitemap
+# protocol see https://www.sitemaps.org
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SITEMAP_URL =
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_SECT_FILTER_ATTRS =
+
+# The QHG_LOCATION tag can be used to specify the location (absolute path
+# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
+# run qhelpgenerator on the generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine tune the look of the index (see "Fine-tuning the output"). As an
+# example, the default style sheet generated by doxygen has an example that
+# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
+# Since the tree basically has the same information as the tab index, you could
+# consider setting DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_TREEVIEW = YES
+
+# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
+# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
+# area (value NO) or if it should extend to the full height of the window (value
+# YES). Setting this to YES gives a layout similar to
+# https://docs.readthedocs.io with more room for contents, but less room for the
+# project logo, title, and description. If either GENERATE_TREEVIEW or
+# DISABLE_INDEX is set to NO, this option has no effect.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FULL_SIDEBAR = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
+# addresses.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+OBFUSCATE_EMAILS = YES
+
+# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
+# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
+# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
+# the HTML output. These images will generally look nicer at scaled resolutions.
+# Possible values are: png (the default) and svg (looks nicer but requires the
+# pdf2svg or inkscape tool).
+# The default value is: png.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FORMULA_FORMAT = png
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_FONTSIZE = 14
+
+# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
+# to create new LaTeX commands to be used in formulas as building blocks. See
+# the section "Including formulas" for details.
+
+FORMULA_MACROFILE =
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# https://www.mathjax.org) which uses client side JavaScript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+USE_MATHJAX = YES
+
+# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
+# Note that the different versions of MathJax have different requirements with
+# regards to the different settings, so it is possible that also other MathJax
+# settings have to be changed when switching between the different MathJax
+# versions.
+# Possible values are: MathJax_2 and MathJax_3.
+# The default value is: MathJax_2.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_VERSION = MathJax_2
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. For more details about the output format see MathJax
+# version 2 (see:
+# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
+# (see:
+# http://docs.mathjax.org/en/latest/web/components/output.html).
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility. This is the name for Mathjax version 2, for MathJax version 3
+# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
+# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
+# is the name for Mathjax version 3, for MathJax version 2 this will be
+# translated into HTML-CSS) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from https://www.mathjax.org before deployment. The default value is:
+# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
+# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH =
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# for MathJax version 2 (see
+# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# For example for MathJax version 3 (see
+# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
+# MATHJAX_EXTENSIONS = ams
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see:
+# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using JavaScript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SERVER_BASED_SEARCH = NO
+
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see:
+# https://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see:
+# https://xapian.org/). See the section "External Indexing and Searching" for
+# details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# Note that when not enabling USE_PDFLATEX the default is latex when enabling
+# USE_PDFLATEX the default is pdflatex and when in the later case latex is
+# chosen this is overwritten by pdflatex. For specific output languages the
+# default can have been set differently, this depends on the implementation of
+# the output language.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_CMD_NAME =
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# Note: This tag is used in the Makefile / make.bat.
+# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
+# (.tex).
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
+# generate index for LaTeX. In case there is no backslash (\) as first character
+# it will be automatically added in the LaTeX code.
+# Note: This tag is used in the generated output file (.tex).
+# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
+# The default value is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_MAKEINDEX_CMD = makeindex
+
+# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PAPER_TYPE = a4
+
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. The package can be specified just
+# by its name or with the correct syntax as to be used with the LaTeX
+# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
+# To use the option intlimits with the amsmath package you can specify:
+# EXTRA_PACKAGES=[intlimits]{amsmath}
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+EXTRA_PACKAGES = amsmath
+
+# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
+# the generated LaTeX document. The header should contain everything until the
+# first chapter. If it is left blank doxygen will generate a standard header. It
+# is highly recommended to start with a default header using
+# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
+# and then modify the file new_header.tex. See also section "Doxygen usage" for
+# information on how to generate the default header that doxygen normally uses.
+#
+# Note: Only use a user-defined header if you know what you are doing!
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. The following
+# commands have a special meaning inside the header (and footer): For a
+# description of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
+# the generated LaTeX document. The footer should contain everything after the
+# last chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer. See also section "Doxygen
+# usage" for information on how to generate the default footer that doxygen
+# normally uses. Note: Only use a user-defined footer if you know what you are
+# doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
+# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
+# files. Set this option to YES, to get a higher quality PDF documentation.
+#
+# See also section LATEX_CMD_NAME for selecting the engine.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+USE_PDFLATEX = YES
+
+# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
+# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
+# mode nothing is printed on the terminal, errors are scrolled as if <return> is
+# hit at every error; missing files that TeX tries to input or request from
+# keyboard input (\read on a not open input stream) cause the job to abort,
+# NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
+# but there is no possibility of user interaction just like in batch mode,
+# SCROLL In scroll mode, TeX will stop only for missing files to input or if
+# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
+# each error, asking for user intervention.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE = plain
+
+# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
+# path from which the emoji images will be read. If a relative path is entered,
+# it will be relative to the LATEX_OUTPUT directory. If left blank the
+# LATEX_OUTPUT directory will be used.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EMOJI_DIRECTORY =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# configuration file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's configuration file. A template extensions file can be
+# generated using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_EXTENSION = .3
+
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
+
+# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
+# namespace members in file scope as well, matching the HTML output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_NS_MEMB_FILE_SCOPE = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT = docbook
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
+# the structure of the code including all documentation. Note that this feature
+# is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to Sqlite3 output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
+# database with symbols found by doxygen stored in tables.
+# The default value is: NO.
+
+GENERATE_SQLITE3 = NO
+
+# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
+# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
+# in front of it.
+# The default directory is: sqlite3.
+# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
+
+SQLITE3_OUTPUT = sqlite3
+
+# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db
+# database file will be recreated with each doxygen run. If set to NO, doxygen
+# will warn if an a database file is already found and not modify it.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
+
+SQLITE3_RECREATE_DB = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO, the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
+# in the source code. If set to NO, only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by the
+# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
+# RECURSIVE has no effect here.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to function-like macros that are alone on a line, have
+# an all uppercase name, and do not end with a semicolon. Such function macros
+# are typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: Each tag file must have a unique name (where the name does NOT include
+# the path). If a tag file is not located in the directory in which doxygen is
+# run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
+# will be listed in the class and namespace index. If set to NO, only the
+# inherited external classes will be listed.
+# The default value is: NO.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
+# in the topic index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
+
+EXTERNAL_GROUPS = YES
+
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to diagram generator tools
+#---------------------------------------------------------------------------
+
+# If set to YES the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz (see:
+# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: NO.
+
+HAVE_DOT = NO
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NUM_THREADS = 0
+
+# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
+# subgraphs. When you want a differently looking font in the dot files that
+# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
+# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
+# Edge and Graph Attributes specification</a> You need to make sure dot is able
+# to find the font, which can be done by putting it in a standard location or by
+# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
+# directory containing the font. Default graphviz fontsize is 14.
+# The default value is: fontname=Helvetica,fontsize=10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
+
+# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
+# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
+# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
+# arrows shapes.</a>
+# The default value is: labelfontname=Helvetica,labelfontsize=10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
+
+# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
+# around nodes set 'shape=plain' or 'shape=plaintext' <a
+# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
+# The default value is: shape=box,height=0.2,width=0.4.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
+
+# You can set the path where dot can find font specified with fontname in
+# DOT_COMMON_ATTR and others dot attributes.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
+# generate a graph for each documented class showing the direct and indirect
+# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
+# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
+# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
+# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
+# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
+# relations will be shown as texts / links.
+# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
+# The default value is: YES.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes. Explicit enabling a collaboration graph,
+# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
+# command \collaborationgraph. Disabling a collaboration graph can be
+# accomplished by means of the command \hidecollaborationgraph.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies. Explicit enabling a group
+# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
+# of the command \groupgraph. Disabling a directory graph can be accomplished by
+# means of the command \hidegroupgraph. See also the chapter Grouping in the
+# manual.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag UML_LOOK is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
+# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
+# tag is set to YES, doxygen will add type and arguments for attributes and
+# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
+# will not generate fields with class member information in the UML graphs. The
+# class diagrams will look similar to the default class diagrams but using UML
+# notation for the relationships.
+# Possible values are: NO, YES and NONE.
+# The default value is: NO.
+# This tag requires that the tag UML_LOOK is set to YES.
+
+DOT_UML_DETAILS = NO
+
+# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
+# to display on a single line. If the actual line length exceeds this threshold
+# significantly it will wrapped across multiple lines. Some heuristics are apply
+# to avoid ugly line breaks.
+# Minimum value: 0, maximum value: 1000, default value: 17.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_WRAP_THRESHOLD = 17
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
+# can be accomplished by means of the command \includegraph. Disabling an
+# include graph can be accomplished by means of the command \hideincludegraph.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDE_GRAPH = YES
+
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
+# set to YES then doxygen will generate a graph for each documented file showing
+# the direct and indirect include dependencies of the file with other documented
+# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
+# to NO, can be accomplished by means of the command \includedbygraph. Disabling
+# an included by graph can be accomplished by means of the command
+# \hideincludedbygraph.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command. Disabling a call graph can be
+# accomplished by means of the command \hidecallgraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command. Disabling a caller graph can be
+# accomplished by means of the command \hidecallergraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
+# dependencies a directory has on other directories in a graphical way. The
+# dependency relations are determined by the #include relations between the
+# files in the directories. Explicit enabling a directory graph, when
+# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
+# \directorygraph. Disabling a directory graph can be accomplished by means of
+# the command \hidedirectorygraph.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DIRECTORY_GRAPH = YES
+
+# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
+# of child directories generated in directory dependency graphs by dot.
+# Minimum value: 1, maximum value: 25, default value: 1.
+# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
+
+DIR_GRAPH_MAX_DEPTH = 1
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# https://www.graphviz.org/)).
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_IMAGE_FORMAT = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG = NO
+
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOTFILE_DIRS =
+
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_PATH =
+
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS =
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file or to the filename of jar file
+# to be used. If left blank, it is assumed PlantUML is not used or called during
+# a preprocessing step. Doxygen will generate a warning when it encounters a
+# \startuml command in this case and will not generate output for the diagram.
+
+PLANTUML_JAR_PATH =
+
+# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
+# configuration file for plantuml.
+
+PLANTUML_CFG_FILE =
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
+# that will be shown in the graph. If the number of nodes in a graph becomes
+# larger than this value, doxygen will truncate the graph, which is visualized
+# by representing a node as a red box. Note that doxygen if the number of direct
+# children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
+# generated by dot. A depth value of 3 means that only nodes reachable from the
+# root by following a path via at most 3 edges will be shown. Nodes that lay
+# further from the root node will be omitted. Note that setting this option to 1
+# or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
+# graphical representation for inheritance and collaboration diagrams is used.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
+# files that are used to generate the various graphs.
+#
+# Note: This setting is not only used for dot files but also for msc temporary
+# files.
+# The default value is: YES.
+
+DOT_CLEANUP = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
+# use a built-in version of mscgen tool to produce the charts. Alternatively,
+# the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
+# specifying prog as the value, doxygen will call the tool as prog -T
+# <outfile_format> -o <outputfile> <inputfile>. The external tool should support
+# output file formats "png", "eps", "svg", and "ismap".
+
+MSCGEN_TOOL =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS =
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/DoxygenLayout.xml b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/DoxygenLayout.xml
new file mode 100644
index 0000000..dfdd003
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/DoxygenLayout.xml
@@ -0,0 +1,242 @@
+<doxygenlayout version="1.0">
+ <!-- Generated by doxygen 1.9.7 -->
+ <!-- Navigation index tabs for HTML output -->
+ <navindex>
+ <tab type="mainpage" visible="yes" title="Home"/>
+ <!-- <tab type="user" url="md_content_2mypage.html" title="Getting Started"/> -->
+ <tab type="pages" visible="yes" title="" intro=""/>
+ <tab type="modules" visible="yes" title="" intro=""/>
+ <tab type="namespaces" visible="yes" title="">
+ <tab type="namespacelist" visible="yes" title="" intro=""/>
+ <tab type="namespacemembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="concepts" visible="yes" title="">
+ </tab>
+ <tab type="interfaces" visible="yes" title="">
+ <tab type="interfacelist" visible="yes" title="" intro=""/>
+ <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="classes" visible="yes" title="">
+ <tab type="classlist" visible="yes" title="" intro=""/>
+ <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="hierarchy" visible="yes" title="" intro=""/>
+ <tab type="classmembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="structs" visible="yes" title="">
+ <tab type="structlist" visible="yes" title="" intro=""/>
+ <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ </tab>
+ <tab type="exceptions" visible="yes" title="">
+ <tab type="exceptionlist" visible="yes" title="" intro=""/>
+ <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="files" visible="yes" title="">
+ <tab type="filelist" visible="yes" title="" intro=""/>
+ <tab type="globals" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="examples" visible="yes" title="" intro=""/>
+ <tab type="user" url="https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/modules/overview/" title="Module Overview" />
+ </navindex>
+
+ <!-- Layout definition for a class page -->
+ <class>
+ <briefdescription visible="yes"/>
+ <includes visible="$SHOW_HEADERFILE"/>
+ <inheritancegraph visible="$CLASS_GRAPH"/>
+ <collaborationgraph visible="$COLLABORATION_GRAPH"/>
+ <memberdecl>
+ <nestedclasses visible="yes" title=""/>
+ <publictypes title=""/>
+ <services title=""/>
+ <interfaces title=""/>
+ <publicslots title=""/>
+ <signals title=""/>
+ <publicmethods title=""/>
+ <publicstaticmethods title=""/>
+ <publicattributes title=""/>
+ <publicstaticattributes title=""/>
+ <protectedtypes title=""/>
+ <protectedslots title=""/>
+ <protectedmethods title=""/>
+ <protectedstaticmethods title=""/>
+ <protectedattributes title=""/>
+ <protectedstaticattributes title=""/>
+ <packagetypes title=""/>
+ <packagemethods title=""/>
+ <packagestaticmethods title=""/>
+ <packageattributes title=""/>
+ <packagestaticattributes title=""/>
+ <properties title=""/>
+ <events title=""/>
+ <privatetypes title=""/>
+ <privateslots title=""/>
+ <privatemethods title=""/>
+ <privatestaticmethods title=""/>
+ <privateattributes title=""/>
+ <privatestaticattributes title=""/>
+ <friends title=""/>
+ <related title="" subtitle=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <inlineclasses title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <services title=""/>
+ <interfaces title=""/>
+ <constructors title=""/>
+ <functions title=""/>
+ <related title=""/>
+ <variables title=""/>
+ <properties title=""/>
+ <events title=""/>
+ </memberdef>
+ <allmemberslink visible="yes"/>
+ <usedfiles visible="$SHOW_USED_FILES"/>
+ <authorsection visible="yes"/>
+ </class>
+
+ <!-- Layout definition for a namespace page -->
+ <namespace>
+ <briefdescription visible="yes"/>
+ <memberdecl>
+ <nestednamespaces visible="yes" title=""/>
+ <constantgroups visible="yes" title=""/>
+ <interfaces visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <concepts visible="yes" title=""/>
+ <structs visible="yes" title=""/>
+ <exceptions visible="yes" title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <inlineclasses title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ </memberdef>
+ <authorsection visible="yes"/>
+ </namespace>
+
+ <!-- Layout definition for a concept page -->
+ <concept>
+ <briefdescription visible="yes"/>
+ <includes visible="$SHOW_HEADERFILE"/>
+ <definition visible="yes" title=""/>
+ <detaileddescription title=""/>
+ <authorsection visible="yes"/>
+ </concept>
+
+ <!-- Layout definition for a file page -->
+ <file>
+ <briefdescription visible="yes"/>
+ <includes visible="$SHOW_INCLUDE_FILES"/>
+ <includegraph visible="$INCLUDE_GRAPH"/>
+ <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
+ <sourcelink visible="yes"/>
+ <memberdecl>
+ <interfaces visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <structs visible="yes" title=""/>
+ <exceptions visible="yes" title=""/>
+ <namespaces visible="yes" title=""/>
+ <concepts visible="yes" title=""/>
+ <constantgroups visible="yes" title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <inlineclasses title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ </memberdef>
+ <authorsection/>
+ </file>
+
+ <!-- Layout definition for a group page -->
+ <group>
+ <briefdescription visible="yes"/>
+ <groupgraph visible="$GROUP_GRAPHS"/>
+ <memberdecl>
+ <nestedgroups visible="yes" title=""/>
+ <dirs visible="yes" title=""/>
+ <files visible="yes" title=""/>
+ <namespaces visible="yes" title=""/>
+ <concepts visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <enumvalues title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <signals title=""/>
+ <publicslots title=""/>
+ <protectedslots title=""/>
+ <privateslots title=""/>
+ <events title=""/>
+ <properties title=""/>
+ <friends title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <pagedocs/>
+ <inlineclasses title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <enumvalues title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <signals title=""/>
+ <publicslots title=""/>
+ <protectedslots title=""/>
+ <privateslots title=""/>
+ <events title=""/>
+ <properties title=""/>
+ <friends title=""/>
+ </memberdef>
+ <authorsection visible="yes"/>
+ </group>
+
+ <!-- Layout definition for a directory page -->
+ <directory>
+ <briefdescription visible="yes"/>
+ <directorygraph visible="yes"/>
+ <memberdecl>
+ <dirs visible="yes"/>
+ <files visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ </directory>
+</doxygenlayout>
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/getting_started.md b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/getting_started.md
new file mode 100644
index 0000000..7152c11
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/getting_started.md
@@ -0,0 +1,339 @@
+# Getting started
+This guide will show you the basic usage of _cost_estimation_. The following steps are necessary (if you are new to UNICADO check out the [settings and outputs](#settingsandoutputs) first!).
+
+## Step-by-step
+It is assumed that you have the `UNICADO package` installed including the executables. In case you are a developer, you need to build the tool first (see [build instructions on UNICADO website](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/build/general/))
+
+
+Execute the following steps to run the module:
+1. Create a dummy `aircraft_exchange_file` (minimal required input see [here](#acXML))
+2. Fill out the `cost_estimation_conf.xml` - change at least:
+ - in the `control_settings` block
+ - `aircraft_exchange_file_name` and `aircraft_exchange_file_directory` to your respective settings
+ - `console_output` at least to `mode_1`
+ - `plot_output` to false (or define `inkscape_path` and `gnuplot_path`)
+ - in `program_settings`
+ - ...
+3. Open terminal and run `cost_estimation`
+
+The following will happen:
+- You see output in the console window
+- A HTML report is created in the directory of the aircraft exchange file (no plots are generated if they are turned off)
+- Results are saved in the aircraft exchange file at the `aircraft_exchange_file/assessment/cost_estimation/operating_cost` node
+
+@note The dummy does not include any aircraft data. Therefore the cost estimation will not work and warnings are expected in the output.
+
+## Settings and outputs {#settingsandoutputs}
+Generally, we use two files to set or configure in UNICADO:
+- the aircraft exchange file (or _acXML_) includes
+ - data related inputs (e.g., aircraft configuration, transport task)
+ - data related outputs (e.g., annual direct operating costs)
+- the configuration file `cost_estimation_conf.xml` (also _configXML_) includes
+ - control settings (e.g., enable/disable generating plots)
+ - program settings (e.g., fees, usage information)
+
+### Aircraft exchange file
+@note The _acXML_ is an exchange file - we agreed on that only data will be saved as output that is needed by another tool!
+
+#### Inputs
+The following information is needed from the _acXML_:
+1. Design specification
+ 1. Configuration information: Configuration type
+ 2. Transport task: Passenger definition, passenger class definition, and cargo definition
+ 3. Energy carriers
+2. Top level aircraft requirements (for design and study mission - if desired)
+ 1. Initial cruise mach number
+ 2. Initial cruise altitude
+ 3. Payload fractions (seat load factor, only required for study mission assessment)
+3. Component design
+ 1. Fuselage: Number of required cabin crew
+ 2. Propulsion: Sea level static thrust per engine
+4. Analysis
+ 1. Masses: Maximum takeoff mass (certified), operating mass empty, maximum payload mass
+ 2. Mission (for design and study mission - if desired)
+ - Range
+ - Flight time
+ - Payload mass
+ - Number of passengers
+ - Number of flight crew
+ - Cargo mass
+ - Takeoff mass
+5. Assessment (aka. payload range data)
+ 1. Range at maximum payload and fuel mass till maximum take off mass limit
+ 2. Range at full tanks and payload till maximum take off mass limit
+ 3. Range for no payload and full tanks (ferry range)
+ 4. Payload at full tanks and payload till maximum take off mass limit
+
+#### Outputs
+The essential results are saved in the _acXML_ node `aircraft_exchange_file/assessment/cost_estimation/operating_cost/direct_operating_cost`.
+When implemented, the indirect operating costs are going to be saved at `aircraft_exchange_file/assessment/cost_estimation/operating_cost/indirect_operating_cost`.
+
+```plaintext
+Direct operating cost
+|- Route independent cost annual
+|- Route dependent cost annual
+|- Direct operating cost annual
+```
+
+Further information can be extracted from the additional output file.
+
+### Configuration file
+The control settings are standardized in UNICADO and will not be described in detail here. The program settings are structured like this (descriptions are in the `cost_estimation_conf.xml`):
+
+```plaintext
+Program Settings
+|- Configuration (ID="tube_and_wing")
+| |- Fidelity name
+| |- Method name
+| |- Fidelity (ID="empirical")
+| | |- Operating cost estimation tu berlin
+| | | |- General direct operating costs parameter
+| | | | | - Capital
+| | | | | | - Depreciation period
+| | | | | | - Price per operating empty mass
+| | | | | | - Rate insurance
+| | | | | | - Rate interest
+| | | | | | - Residual value factor
+| | | | | - Crew
+| | | | | | - Salary variation
+| | | | | - Flight cycles
+| | | | | | - Block time per flight
+| | | | | | - Daily night curfew time
+| | | | | | - Potential annual operation time
+| | | | | | - Annual lay days overhaul
+| | | | | | - Annual lay days reserve
+| | | | | | - Annual lay days maintenance
+| | | | | - Handling
+| | | | | | - Fees handling
+| | | | | - Landing
+| | | | | | - Fees landing
+| | | | | - Air traffic control
+| | | | | | - Air traffic control price factor design
+| | | | | | - Air traffic control price factor study
+| | | | | - Maintenance
+| | | | | | - Airframe repair cost per flight
+| | | | | | - Cost burden
+| | | | | | - Rate labor
+| | | | | - Related direct operating costs
+| | | | | | - Revenue per freight km design
+| | | | | | - Revenue per freight km study
+| | | | | - Miscellaneous
+| | | | | | - Rate inflation
+| | | |- Fuel type (ID="kerosene")
+| | | | | - Factor engine maintenance
+| | | | | - Fuel price
+| | | | | - Ratio operating empty mass
+| | | |- Fuel type (ID="liquid_hydrogen")
+| | | | | - Factor engine maintenance
+| | | | | - Fuel price
+| | | | | - Ratio operating empty mass
+```
+
+## Minimal required aircraft exchange file input {#acXML}
+As the _cost_estimation_ tool is part of the assessment modules in UNICADO, it is based on the assumption that a converged design and a correspondingly complete _acXML_ file are already available. The following parameters are required to generate results with the tool.
+
+```xml
+<aircraft_exchange_file>
+ <requirements_and_specifications description="Requirements and specifications">
+ <design_specification description="Design specification">
+ <configuration description="Configuration information">
+ <configuration_type description="aircraft configuration: tube_and_wing / blended_wing_body">
+ <value>tube_and_wing</value>
+ </configuration_type>
+ </configuration>
+ <transport_task>
+ <passenger_definition description="Define the masses of the passengers">
+ <mass_per_passenger description="Design mass of a single passenger WITHOUT luggage">
+ <value>80</value>
+ <unit>kg</unit>
+ <lower_boundary>50</lower_boundary>
+ <upper_boundary>200</upper_boundary>
+ </mass_per_passenger>
+ <luggage_mass_per_passenger description="Design mass of a the luggage for a single passenger">
+ <value>17</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>25</upper_boundary>
+ </luggage_mass_per_passenger>
+ </passenger_definition>
+ <passenger_class_definition>
+ <class_distribution description="Relative passenger distribution for the classes: President Class/First Class/Business Class/Premium Economy/Economy. Sum must be equal to 1!">
+ <value>0/0/0/0.1/0.9</value>
+ </class_distribution>
+ </passenger_class_definition>
+ <cargo_definition description="Definition of cargo which does not belong to passengers">
+ <additional_cargo_mass description="Mass of cargo which does not belong to passengers">
+ <value>500</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </additional_cargo_mass>
+ <cargo_density description="Density of cargo which does not belong to passengers">
+ <value>165</value>
+ <unit>kg/m^3</unit>
+ <lower_boundary>150</lower_boundary>
+ <upper_boundary>200</upper_boundary>
+ </cargo_density>
+ </cargo_definition>
+ </transport_task>
+ <energy_carriers description="Energy carriers information">
+ <energy_carrier ID="0" description="One specific energy carrier">
+ <type description="Energy type: kerosene / liquid_hydrogen / battery / saf (for multifuel engine create new ID)">
+ <value>kerosene</value>
+ </type>
+ </energy_carrier>
+ </energy_carriers>
+ </design_specification>
+ <requirements description="Aircraft design requirements">
+ <top_level_aircraft_requirements description="Top level aircraft requirements (TLAR)">
+ <design_mission description="Requirements regarding the design mission">
+ <initial_cruise_mach_number description="Initial cruise Mach number at top of descent. May be altered during cruise.">
+ <value>0.78</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </initial_cruise_mach_number>
+ <initial_cruise_altitude description="Initial cruise altitude (ICA) at top of descent. May be altered during cruise.">
+ <value>10058.4</value>
+ <unit>m</unit>
+ <lower_boundary>1000</lower_boundary>
+ <upper_boundary>20000</upper_boundary>
+ </initial_cruise_altitude>
+ </design_mission>
+ </top_level_aircraft_requirements>
+ </requirements>
+ </requirements_and_specifications>
+ <component_design>
+ <fuselage description="Geometric description of the aircraft fuselage." tool_level="1">
+ <specific description="Fuselage design specific output parameter.">
+ <geometry description="Geometry description of the entire fuselage design.">
+ <fuselage ID="0" description="Geometrical description of one entire fuselage.">
+ <number_of_required_cabin_crew description="Number of minimum required flight attendants.">
+ <value>4</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100</upper_boundary>
+ </number_of_required_cabin_crew>
+ </fuselage>
+ </geometry>
+ </specific>
+ </fuselage>
+ <propulsion>
+ <specific>
+ <propulsion ID="0" description="Description of one propulsion">
+ <engine>
+ <SLST description="Sea level static thrust of the engine">
+ <value>109167.0872</value>
+ <unit>N</unit>
+ <lower_boundary>-1.797693135e+308</lower_boundary>
+ <upper_boundary>1.797693135e+308</upper_boundary>
+ </SLST>
+ </engine>
+ </propulsion>
+ </specific>
+ </propulsion>
+ </component_design>
+ <analysis>
+ <masses_cg_inertia>
+ <maximum_takeoff_mass>
+ <mass_properties>
+ <mass description="mass">
+ <value>66042.62842</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ </mass_properties>
+ </maximum_takeoff_mass>
+ <operating_mass_empty>
+ <mass_properties>
+ <mass description="mass">
+ <value>36209.43617</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>300000</upper_boundary>
+ </mass>
+ </mass_properties>
+ </operating_mass_empty>
+ <maximum_payload_mass>
+ <mass_properties>
+ <mass description="mass">
+ <value>66042.62842</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ </mass_properties>
+ </maximum_payload_mass>
+ </masses_cg_inertia>
+ <mission description="Mission data." tool_level="0">
+ <design_mission description="Data of design mission">
+ <range description="Traveled range from break release to end of taxi at destination">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>5000000</upper_boundary>
+ </range>
+ <flight_time description="Flight time for the whole mission">
+ <value>0</value>
+ <unit>s</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>44500</upper_boundary>
+ </flight_time>
+ <payload_mass description="Total payload carried by the aircraft">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>150000</upper_boundary>
+ </payload_mass>
+ <number_of_pax description="Number of passengers for the mission">
+ <value>0</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </number_of_pax>
+ <number_of_flight_crew description="Number of flight crew member for the mission">
+ <value>0</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </number_of_flight_crew>
+ <cargo_mass description="Cargo mass">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </cargo_mass>
+ <takeoff_mass description="Takeoff mass">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>150000</upper_boundary>
+ </takeoff_mass>
+ </design_mission>
+ </mission>
+ </analysis>
+ <assessment>
+ <performance description="Assessment of performance values">
+ <range tool_level="0">
+ <range_max_payload_at_maximum_takeoff_mass description="Range at maximum payload and fuel mass till maximum take off mass limit">
+ <value>0</value>
+ <unit>m</unit>
+ </range_max_payload_at_maximum_takeoff_mass>
+ <range_max_fuel_at_maximum_takeoff_mass description="Range at full tanks and payload till maximum take off mass limit">
+ <value>0</value>
+ <unit>m</unit>
+ </range_max_fuel_at_maximum_takeoff_mass>
+ <payload_maximum_fuel_at_maximum_takeoff_mass description="Payload at full tanks and payload till maximum take off mass limit">
+ <value>0</value>
+ <unit>kg</unit>
+ </payload_maximum_fuel_at_maximum_takeoff_mass>
+ <range_maximum_fuel_empty description="Range for no payload and full tanks">
+ <value>0</value>
+ <unit>m</unit>
+ </range_maximum_fuel_empty>
+ </range>
+ </performance>
+ </assessment>
+</aircraft_exchange_file>
+```
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/index.md b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/index.md
new file mode 100644
index 0000000..2191696
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/index.md
@@ -0,0 +1,16 @@
+# Introduction {#mainpage}
+Welcome to the _cost_estimation_ module in UNICADO. [...]
+
+## Summary of features
+Here’s a quick rundown of what the tool currently does, along with a sneak peek at what's planned:
+
+ Configuration | Fidelity | Method(s) | Energy carrier |Cost share | Status |
+------------------|-----------|-----------|-----------------|-------------------------|:------------------------------:|
+Tube-and-wing |Empirical |TU Berlin |Kerosene |Direct operating cost |running \emoji white_check_mark |
+Tube-and-wing |Empirical |TU Berlin |Kerosene |Indirect operating cost |missing \emoji construction |
+Tube-and-wing |Empirical |TU Berlin |Liquid hydrogen |Direct operating cost |running \emoji white_check_mark |
+Tube-and-wing |Empirical |TU Berlin |Liquid hydrogen |Indirect operating cost |missing \emoji construction |
+Blended-wing-body |... |... |... |... |missing \emoji construction |
+
+## Ready for takeoff
+The [getting started page](getting_started.md) provides an initial understanding of how to execute the tool and its fundamental operations. For a comprehensive understanding of the tool’s functionality, the documentation is structured into two distinct sections: a [method description](operating_cost_method.md) and a [software architecture](software_architecture.md) section.
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/operating_cost_method.md b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/operating_cost_method.md
new file mode 100644
index 0000000..1ba8cef
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/operating_cost_method.md
@@ -0,0 +1,3 @@
+# Calculation method
+
+Add method description here...
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/software_architecture.md b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/software_architecture.md
new file mode 100644
index 0000000..e02b42f
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/software_architecture.md
@@ -0,0 +1,2 @@
+# Software architecture
+Add information on software architecture here.
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/header.html b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/header.html
new file mode 100644
index 0000000..92af47f
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/header.html
@@ -0,0 +1,86 @@
+<!-- HTML header for doxygen 1.9.8-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="generator" content="Doxygen $doxygenversion"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
+<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
+<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
+<!--BEGIN DISABLE_INDEX-->
+ <!--BEGIN FULL_SIDEBAR-->
+<script type="text/javascript">var page_layout=1;</script>
+ <!--END FULL_SIDEBAR-->
+<!--END DISABLE_INDEX-->
+<script type="text/javascript" src="$relpath^jquery.js"></script>
+<script type="text/javascript" src="$relpath^dynsections.js"></script>
+<script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
+<script type="text/javascript">
+ DoxygenAwesomeDarkModeToggle.init()
+</script>
+<script type="text/javascript" src="$relpath^doxygen-awesome-tabs.js"></script>
+<script type="text/javascript">
+ DoxygenAwesomeTabs.init()
+</script>
+<script type="text/javascript" src="$relpath^doxygen-awesome-fragment-copy-button.js"></script>
+<script type="text/javascript">
+ DoxygenAwesomeFragmentCopyButton.init()
+</script>
+$treeview
+$search
+$mathjax
+$darkmode
+<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
+$extrastylesheet
+</head>
+<body>
+<!--BEGIN DISABLE_INDEX-->
+ <!--BEGIN FULL_SIDEBAR-->
+<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
+ <!--END FULL_SIDEBAR-->
+<!--END DISABLE_INDEX-->
+
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+
+<!--BEGIN TITLEAREA-->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr id="projectrow">
+ <!--BEGIN PROJECT_LOGO-->
+ <td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
+ <!--END PROJECT_LOGO-->
+ <!--BEGIN PROJECT_NAME-->
+ <td id="projectalign">
+ <div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber"> $projectnumber</span><!--END PROJECT_NUMBER-->
+ </div>
+ <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
+ </td>
+ <!--END PROJECT_NAME-->
+ <!--BEGIN !PROJECT_NAME-->
+ <!--BEGIN PROJECT_BRIEF-->
+ <td>
+ <div id="projectbrief">$projectbrief</div>
+ </td>
+ <!--END PROJECT_BRIEF-->
+ <!--END !PROJECT_NAME-->
+ <!--BEGIN DISABLE_INDEX-->
+ <!--BEGIN SEARCHENGINE-->
+ <!--BEGIN !FULL_SIDEBAR-->
+ <td>$searchbox</td>
+ <!--END !FULL_SIDEBAR-->
+ <!--END SEARCHENGINE-->
+ <!--END DISABLE_INDEX-->
+ </tr>
+ <!--BEGIN SEARCHENGINE-->
+ <!--BEGIN FULL_SIDEBAR-->
+ <tr><td colspan="2">$searchbox</td></tr>
+ <!--END FULL_SIDEBAR-->
+ <!--END SEARCHENGINE-->
+ </tbody>
+</table>
+</div>
+<!--END TITLEAREA-->
+<!-- end header part -->
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/main.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/main.py
new file mode 100644
index 0000000..0a16cd5
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/main.py
@@ -0,0 +1,88 @@
+"""Calculation module main file."""
+# Import standard modules.
+import logging
+import traceback
+from sys import argv, exit
+
+# Import own modules.
+from runmodule import run_module
+from src.datapreprocessing import data_preprocessing
+from src.datapostprocessing import data_postprocessing
+
+
+def main():
+ """Execute the main program for cost estimation.
+
+ This function serves as the main entry point for performing the cost estimation.
+ It goes through the following key steps:
+ (1) Preprocessing - Acquire necessary data and paths: Call the 'data_preprocessing' function from
+ 'datapreprocessing.py' to set up data and routing information.
+ (2) Run (main processing) - Execute code depending on method layers: Execute the 'run_module' function from the
+ 'methodexecutionpackage' library. The 'run_module' function is responsible for the programs primary logic.
+ (3) Postprocessing - Write data to the aircraft exchange file and generate plots and reports: Call the
+ 'data_postprocessing' function from 'datapostprocessing.py' to handle postprocessing tasks. This step receives
+ data from both the preprocessing and the main processing step.
+
+ Note: The 'routing_dict' dictionary is used to manage the routing and execution of different program components.
+
+ :raises Exception: Raised to handle other exceptions
+ :return: None
+ """
+
+ # Initialize exception string and runtime output logger.
+ tool_name = 'cost estimation'
+ runtime_output = logging.getLogger('module_logger')
+
+ try:
+ """Preprocessing: Acquire necessary data and paths."""
+ # Run 'data_preprocessing' function from 'datapreprocessing.py'.
+ paths_and_names, routing_dict, runtime_output = data_preprocessing('cost_estimation_conf.xml', argv)
+ runtime_output.print('Cost estimation started...')
+
+ """Run: Execute code depending on method layers."""
+ # Execute 'run_module' function from 'methodexecutionpackage' library. This function is responsible for the main
+ # logic of the program.
+ run_output_dict = run_module(paths_and_names, routing_dict, runtime_output)
+
+ """Postprocessing: Write data to aircraft exchange file and generate plots and reports."""
+ # Run 'data_postprocessing' function from 'datapostprocessing.py' to handle postprocessing tasks. Receives data
+ # from preprocessing and main processing step.
+ data_postprocessing(paths_and_names, routing_dict, run_output_dict, runtime_output)
+ runtime_output.print('Operating cost estimation finished.')
+
+ except Exception as e: # pylint: disable=broad-exception-caught
+ # Handle other exceptions.
+ runtime_output.critical(exception_string_msg(e, tool_name))
+ exit(1)
+
+
+def exception_string_msg(error, tool_name: str):
+ """Generate exception message.
+
+ Generate a formatted string detailing the type and location of an exception, along with an error message, for
+ diagnostic purposes. This function is particularly useful for logging or displaying comprehensive error information
+ when an exception occurs in a specific module or function.
+
+ :param exception error: Caught exception object from which details will be extracted
+ :param str tool_name: Name of the tool or module where the error occurred, used in the final error message
+ :return str: String including error type, file name, function/method name, line number, code that caused the error,
+ and error message.
+ """
+ error_type = str(type(error).__name__)
+ error_trace = traceback.extract_tb(error.__traceback__)
+ error_file, error_line, error_func, error_code = error_trace[-1]
+ error_file = error_file.split('/')[-1]
+
+ exception_string = f"{error_type}: \n"
+ exception_string += f" - File : {error_file} \n"
+ exception_string += f" - Function / Method: {error_func} \n"
+ exception_string += f" - Line : {error_line} \n"
+ exception_string += f" - Code : {error_code} \n"
+ exception_string += f" - Error message : {str(error)} \n"
+
+ return exception_string + f"Main execution of {tool_name} module failed! \n" \
+ f"Program aborted."
+
+
+if __name__ == "__main__":
+ main()
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/Icon\r"
new file mode 100644
index 0000000..e69de29
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/blended_wing_body/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/blended_wing_body/Icon\r"
new file mode 100644
index 0000000..e69de29
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/datapostprocessing.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/datapostprocessing.py
new file mode 100644
index 0000000..3ffa408
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/datapostprocessing.py
@@ -0,0 +1,81 @@
+"""Module providing functions for data postprocessing."""
+# Import standard modules.
+
+# Import own modules.
+from datapostprocessingmodule import method_data_postprocessing
+from datapostprocessingmodule import write_key_data_to_aircraft_exchange_file
+from datapostprocessingmodule import prepare_element_tree_for_module_key_parameter
+
+
+def data_postprocessing(paths_and_names, routing_dict, data_dict, runtime_output):
+ """Perform data postprocessing and write data to an aircraft exchange file.
+
+ This function is responsible for data postprocessing that involves the following steps:
+ (1) Data preparation: The module manager prepares a list containing all paths to the key parameters that must
+ be written to the aircraft exchange file.
+ (2) Write data to the aircraft exchange file: The results of the module execution are passed on to the function
+ responsible for properly writing the data to the aircraft exchange file.
+ (3) Method-specific data postprocessing: User-defined method-specific postprocessing is conducted as needed.
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing routing parameters
+ :param dict data_dict: Dictionary containing the result of the module execution (direct operating cost estimation)
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :return: None
+ """
+
+ """Data preparation."""
+ # Changes to this list are the sole responsibility of the module manager!
+ paths_to_key_parameters_list = [
+ './assessment/operating_cost_estimation_tu_berlin/direct_operating_costs/direct_operating_costs_annual',
+ './assessment/operating_cost_estimation_tu_berlin/indirect_operating_costs/indirect_operating_costs_annual'
+ ]
+
+ module_key_parameters_dict = {
+ 'assessment': {
+ 'operating_cost_estimation_tu_berlin': {
+ 'attributes': {
+ 'description': 'Operating costs (sum of direct and indirect operating costs)',
+ 'tool_level': '0'},
+ 'direct_operating_costs': {
+ 'attributes': {
+ 'description': 'Direct operating costs (sum of route independent and route dependent costs)'},
+ 'direct_operating_costs_annual': {
+ 'attributes': {'description': 'Direct operating costs (DOC) per year'},
+ 'value': '0',
+ 'unit': 'EUR/y',
+ 'lower_boundary': '0',
+ 'upper_boundary': 'inf'}
+ },
+ 'indirect_operating_costs': {
+ 'attributes': {'description': 'Indirect operating costs (IOC)'},
+ 'indirect_operating_costs_annual': {
+ 'attributes': {'description': 'Indirect operating costs (IOC) per year'},
+ 'value': '0',
+ 'unit': 'EUR/y',
+ 'lower_boundary': '0',
+ 'upper_boundary': 'inf'}
+ }
+ }
+ }
+ }
+
+ paths_and_names = prepare_element_tree_for_module_key_parameter(paths_and_names, module_key_parameters_dict)
+
+ # Run 'user_method_data_output_preparation' from 'usermethoddatapreparation.py'.
+ key_output_dict, method_specific_output_dict = routing_dict['func_user_method_data_output_preparation'](data_dict)
+ # Extract tool level from routing dictionary.
+ tool_level = routing_dict['tool_level']
+
+ """Write data to aircraft exchange file."""
+ # Extract root and path to aircraft exchange file.
+ root_of_aircraft_exchange_tree = paths_and_names['root_of_aircraft_exchange_tree']
+ path_to_aircraft_exchange_file = paths_and_names['path_to_aircraft_exchange_file']
+ # Write key data to aircraft exchange file.
+ write_key_data_to_aircraft_exchange_file(root_of_aircraft_exchange_tree, path_to_aircraft_exchange_file,
+ paths_to_key_parameters_list, key_output_dict, tool_level, runtime_output)
+
+ """Method-specific postprocessing."""
+ # Run 'method_data_postprocessing' from 'datapostprocessingmodule'.
+ method_data_postprocessing(paths_and_names, routing_dict, data_dict,
+ method_specific_output_dict, runtime_output)
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/datapreprocessing.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/datapreprocessing.py
new file mode 100644
index 0000000..8ac8754
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/datapreprocessing.py
@@ -0,0 +1,126 @@
+"""Module providing functions for data preprocessing."""
+# Import standard modules.
+import importlib
+import sys
+
+# Import own modules.
+from datapreprocessingmodule import get_paths_and_names, read_routing_values_from_xml
+from src.readlayertext import read_energy_carrier
+
+
+def data_preprocessing(module_configuration_file, argv):
+ """Conduct data preprocessing.
+
+ This function provides data preprocessing functionalities. It sets up the necessary data and imports relevant
+ modules. The importlib module is used to dynamically import necessary modules.
+
+ The output dictionary 'preprocessing_dict' contains the following values:
+ - 'layer_1': First routing layer (aircraft configuration) (str)
+ - 'layer_2': Second routing layer (calculation method fidelity) (str)
+ - 'layer_3': Third routing layer (calculation method) (str)
+ - 'user_layer': Last routing layer (fuel type) (user layer) (str)
+ - 'tool_level': Tool level of current tool (str)
+ - 'module_import_name': Dynamic string for dynamically generated module import name based on layers (str)
+ - 'module_name': Module name (name of the module configuration file without its file extension) (str)
+ - 'func_user_method_data_input_preparation': Reference to 'user_method_data_input_preparation' function
+ - 'func_user_method_data_output_preparation': Reference to 'user_method_data_output_preparation' function
+ - 'func_user_method_plot': Reference to 'method_plot' function
+ - 'func_user_method_html_report': Reference to 'method_html_report' function
+ - 'func_user_method_xml_export': Reference to 'method_xml_export' function
+
+ :param str module_configuration_file: Name of module configuration file
+ :param list argv: List with optional input arguments
+ :raises ModuleNotFoundError: Raised if module import failed
+ :returns:
+ - dict paths_and_names: Dictionary containing system paths and ElementTrees
+ - dict preprocessing_dict: Dictionary containing data preprocessing results
+ - logging.Logger runtime_output: Logging object used for capturing log messages in the module
+
+ """
+
+ """Get paths, names, and xml trees for module configuration and aircraft exchange file."""
+ # Call 'get_paths_and_names' function to obtain various paths and names.
+ paths_and_names, runtime_output = get_paths_and_names(module_configuration_file, argv)
+ # Note: It is the exclusive responsibility of the module manager to modify the following information!
+ # Create layer description dictionary according to the number of individual layers. The dictionary associates
+ # layers with their respective XML paths and expected data types according to the following scheme:
+ # layer_description_dict = {'layer_1': [path, expected data type], 'layer_2': [...]}
+ # If any information cannot be directly extracted from a specific aircraft exchange file path, please write 'None'
+ # and manually add the missing value afterward.
+ aircraft_exchange_tmp_path = 'aircraft_exchange_file/requirements_and_specifications/design_specification/'
+ module_configuration_tmp_path = 'module_configuration_file/program_settings/configuration/'
+ layer_description_dict = {
+ 'layer_1': [aircraft_exchange_tmp_path + 'configuration/configuration_type/value', float],
+ 'layer_2': [module_configuration_tmp_path + 'fidelity_name/value', str],
+ 'layer_3': [module_configuration_tmp_path + 'method_name/value', str],
+ 'user_layer': [None, str]
+ }
+
+ """ Extract data from aircraft exchange and module configuration file."""
+ # Extract root and path to aircraft exchange file and write key data to aircraft exchange file.
+ root_of_aircraft_exchange_tree = paths_and_names['root_of_aircraft_exchange_tree']
+ root_of_module_configuration_file = paths_and_names['root_of_module_config_tree']
+ # Extract data from *.xml files based on the provided layer description (if no path information given ('None'),
+ # the entry has to be specified manually afterward). The result is stored in the 'preprocessing_dict' dictionary.
+ # It has the following output format (all values are strings):
+ # dict_out = {'layer_1': value, 'layer_2': value, 'layer_3': value, 'user_layer': value, 'tool_level': value}
+ preprocessing_dict = read_routing_values_from_xml(layer_description_dict, root_of_aircraft_exchange_tree,
+ root_of_module_configuration_file, runtime_output)
+ # Manual specification of missing layer values ('None' entry layer).
+ preprocessing_dict['user_layer'] = read_energy_carrier(root_of_aircraft_exchange_tree, runtime_output)
+
+ """Prepare and import modules."""
+ # Generate a dynamic import name 'module_import_name' for the selected calculation method modules based on the
+ # provided layer values according to the following scheme:
+ # 'src.[value of layer_1].[value of layer_2].[value of layer_3]'
+ module_import_name = 'src'
+ for _, value in list(preprocessing_dict.items())[:-2]:
+ module_import_name += '.' + value
+ # Create import commands by appending the python file name (incl. sub-folders, if necessary) to the generated
+ # 'module_import_name'. E.g., the import command for the module import from the 'usermethoddatapreparation.py' file
+ # is as follows:
+ # 'src.[value of layer_1].[value of layer_2].[value of layer_3].usermethoddatapreparation'
+ # The import command for the module import from the 'methodplot.py' file in the 'general' folder is as follows:
+ # 'src.[value of layer_1].[value of layer_2].[value of layer_3].general.methodplot'
+ # This step is executed for the following python files:
+ # * 'usermethoddatapreparation.py'
+ # * 'methodplot.py'
+ # * 'methodhtmlreport.py'
+ # * 'methodxmlexport.py'
+ # * 'methodtexoutput'.py'
+ import_command_user_method_data_preparation = module_import_name + '.usermethoddatapreparation'
+ import_command_user_method_plot = module_import_name + '.general.methodplot'
+ import_command_user_method_html_report = module_import_name + '.general.methodhtmlreport'
+ import_command_user_method_xml_export = module_import_name + '.general.methodxmlexport'
+ import_command_user_method_tex_output = module_import_name + '.general.methodtexoutput'
+
+ # Add module name and tool level to the preprocessing_dict.
+ preprocessing_dict['module_import_name'] = module_import_name
+ preprocessing_dict['module_name'] = module_configuration_file[:-9]
+
+ # Dynamically import modules and functions based on the generated import commands.
+ try:
+ # Import functions from the specified modules.
+ import_user_method_data_preparation = importlib.import_module(import_command_user_method_data_preparation)
+ import_user_method_plot = importlib.import_module(import_command_user_method_plot)
+ import_user_method_html_report = importlib.import_module(import_command_user_method_html_report)
+ import_user_method_xml_export = importlib.import_module(import_command_user_method_xml_export)
+ import_user_method_tex_output = importlib.import_module(import_command_user_method_tex_output)
+ # Save the imported functions as variables in the 'preprocessing_dict' dictionary.
+ preprocessing_dict['func_user_method_data_input_preparation'] \
+ = import_user_method_data_preparation.user_method_data_input_preparation
+ preprocessing_dict['func_user_method_data_output_preparation'] \
+ = import_user_method_data_preparation.user_method_data_output_preparation
+ preprocessing_dict['func_user_method_plot'] = import_user_method_plot.method_plot
+ preprocessing_dict['func_user_method_html_report'] = import_user_method_html_report.method_html_report
+ preprocessing_dict['func_user_method_xml_export'] = import_user_method_xml_export.method_xml_export
+ preprocessing_dict['func_user_method_tex_output'] = import_user_method_tex_output.method_tex_output
+ # Exception handling for module import error.
+ except ModuleNotFoundError as module_import_error:
+ runtime_output_string = ('Error: ' + str(module_import_error) + ' found in '
+ + preprocessing_dict['module_name'] + '.\n'
+ + ' Program aborted.')
+ runtime_output.critical(runtime_output_string)
+ sys.exit(1)
+
+ return paths_and_names, preprocessing_dict, runtime_output
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/readlayertext.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/readlayertext.py
new file mode 100644
index 0000000..35d6e1f
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/readlayertext.py
@@ -0,0 +1,86 @@
+"""File providing functions to read layer text from aircraft XML file."""
+# Import standard libraries.
+import sys
+
+
+def read_energy_carrier(root_of_aircraft_exchange_tree, runtime_output):
+ """Read energy carrier from aircraft exchange file.
+
+ This function extracts information about the energy carrier used in an aircraft from the provided aircraft exchange
+ file. It specifically looks for 'energy_carrier' nodes and their corresponding 'energy_carrier' sub-nodes.
+
+ :param ElementTree root_of_aircraft_exchange_tree: Root of aircraft exchange XML
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :raises ValueError: Raised if energy carrier node does not exist
+ :return string energy_carrier: Energy carrier string
+ """
+
+ # Initialize empty list.
+ energy_carrier_list = []
+
+ # Attempt to extract information on energy carrier from aircraft exchange file.
+ try:
+ # Find all 'energy_carrier' nodes in aircraft exchange file.
+ energy_carrier_node_list = root_of_aircraft_exchange_tree.findall('.//energy_carrier')
+ # Check, if 'energy_carrier' nodes exist.
+ if not energy_carrier_node_list:
+ # Raise error, if no energy carrier node exists.
+ raise ValueError('No energy carriers nodes found in the aircraft exchange file. Program aborted.')
+ # Iterate over 'energy_carrier_node_list' and append values of energy carrier sub-nodes.
+ for energy_carrier_type_node in energy_carrier_node_list:
+ energy_carrier_node = energy_carrier_type_node.find('.//type/value')
+ if energy_carrier_node is not None:
+ energy_carrier_list.append(energy_carrier_node.text)
+ else:
+ raise ValueError('No energy carrier nodes found in the aircraft exchange file. Program aborted.')
+
+ # If 'energy_carrier_list' is not empty, compare all entries.
+ if energy_carrier_list is not None:
+ # If all entries are the same, set 'energy_carrier' to first list entry.
+ if all(element == energy_carrier_list[0] for element in energy_carrier_list):
+ energy_carrier = energy_carrier_list[0]
+ # If list entries differ, set 'energy_carrier' to 'hybrid'.
+ else:
+ energy_carrier = 'hybrid'
+ # Raise error, if 'energy_carrier_list' is empty.
+ else:
+ raise ValueError('No energy carrier node found. Program aborted.')
+
+ # Exception handling for ValueError.
+ except ValueError as e:
+ runtime_output.critical('Error: ' + str(e))
+ sys.exit(1)
+
+ return energy_carrier
+
+
+def read_engine_configuration(root_of_aircraft_exchange_tree, runtime_output):
+ """Read engine configuration.
+
+ Read engine configuration from aircraft exchange file.
+
+ :param ElementTree root_of_aircraft_exchange_tree: Root of aircraft exchange XML
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :return str engine_configuration: Information on engine configuration
+ """
+
+ engine_configuration = 'xyz'
+ print(engine_configuration)
+
+ return engine_configuration
+
+
+def read_tank_configuration(root_of_aircraft_exchange_tree, runtime_output):
+ """Read tank configuration.
+
+ Read tank configuration information from aircraft exchange file.
+
+ :param ElementTree root_of_aircraft_exchange_tree: Root of aircraft exchange XML
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :return str tank_configuration: Information on tank configuration
+ """
+
+ tank_configuration = 'xyz'
+ print(tank_configuration)
+
+ return tank_configuration
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/Icon\r"
new file mode 100644
index 0000000..e69de29
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/Icon\r"
new file mode 100644
index 0000000..e69de29
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/Icon\r"
new file mode 100644
index 0000000..e69de29
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/Icon\r"
new file mode 100644
index 0000000..e69de29
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodhtmlreport.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodhtmlreport.py
new file mode 100644
index 0000000..9cef4c0
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodhtmlreport.py
@@ -0,0 +1,19 @@
+"""Module providing HTML report functionalities for current calculation method."""
+
+
+def method_html_report(paths_and_names, routing_dict, data_dict, method_specific_output_dict, runtime_output):
+ """HTML report function.
+
+ This function is responsible for creating HTML reports.
+ [Add further information here...]
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing routing parameters
+ :param dict data_dict: Dictionary containing results of module execution
+ :param dict method_specific_output_dict: Dictionary containing method specific output data
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :return: None
+ """
+
+ # This is just a dummy code snippet. Insert your code here.
+ runtime_output.warning('Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.')
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodplot.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodplot.py
new file mode 100644
index 0000000..25b7588
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodplot.py
@@ -0,0 +1,23 @@
+"""Module providing plotting functionalities for current calculation method."""
+# Import standard libraries.
+import os
+from matplotlib import pyplot as plt
+import numpy as np
+
+
+def method_plot(paths_and_names, routing_dict, data_dict, method_specific_output_dict, runtime_output):
+ """Plot function.
+
+ This function is responsible for creating plots.
+ [Add further information here...]
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing routing parameters
+ :param dict data_dict: Dictionary containing results of module execution
+ :param dict method_specific_output_dict: Dictionary containing method specific output data
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :return: None
+ """
+
+ # This is just a dummy code snippet. Insert your code here.
+ runtime_output.print('Warning: No "method_plot" function in "methodplot.py" file implemented yet.')
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodtexoutput.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodtexoutput.py
new file mode 100644
index 0000000..87a9aa0
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodtexoutput.py
@@ -0,0 +1,19 @@
+"""Module providing report functionalities for current calculation method."""
+
+
+def method_tex_output(paths_and_names, routing_dict, data_dict, method_specific_output_dict, runtime_output):
+ """TeX file output function.
+
+ This function is responsible for creating TeX output files.
+ [Add further information here...]
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing routing parameters
+ :param dict data_dict: Dictionary containing results of module execution
+ :param dict method_specific_output_dict: Dictionary containing method specific output data
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :return: None
+ """
+
+ # This is just a dummy code snippet. Insert your code here.
+ runtime_output.warning('Warning: No "method_tex_output" function in "methodtexoutput.py" file implemented yet.')
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodxmlexport.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodxmlexport.py
new file mode 100644
index 0000000..582a61e
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/methodxmlexport.py
@@ -0,0 +1,103 @@
+"""Module providing export functionalities for current calculation method."""
+# Import standard libraries.
+import xml.etree.ElementTree as ET
+
+
+def method_xml_export(paths_and_names, routing_dict, data_dict, method_specific_output_dict, xml_export_tree,
+ path_to_results_file, runtime_output):
+ """Export function.
+
+ This function is responsible for the export of method-specific data to the corresponding method-specific XML. In
+ detail, this includes the following steps:
+ (1) Parse the XML file specified by the 'path_to_results_file' variable.
+ (2) Find the 'calculation_results' element in the XML file. This is the element under which method-specific
+ nodes will be added.
+ (3) Extract method-related information from the configuration file, such as the method name and description and
+ add method node.
+ (4) Extract design mission data from the method-specific output dictionary and write it to the XML file.
+ (5) If a study exists, extract study data from the method-specific output dict and write it to the XML file.
+ (6) Attempt to write the modified XML data back to the 'costEstimation_results.xml' file. Handle an OSError
+ exception in case an error occurs during this operation.
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing routing parameters
+ :param dict data_dict: Dictionary containing results of module execution
+ :param dict method_specific_output_dict: Dictionary containing method-specific output data
+ :param ElementTree xml_export_tree: Element tree of method-specific XML tree
+ :param str path_to_results_file: Path to method-specific output XML file
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :raises OSError: Raised if writing to aircraft exchange file failed
+ :return: None
+ """
+ runtime_output.print("Method-specific data are written to '" + routing_dict['module_name'] + "_results.xml'...")
+
+ # Function to write data to 'cost_estimation_results.xml'
+ root_of_results_file = xml_export_tree.getroot()
+ parent = root_of_results_file.find('calculation_results')
+ # Add method node.
+ root_of_module_config_tree = paths_and_names['root_of_module_config_tree']
+ method_name = root_of_module_config_tree.find('./program_settings/configuration/method_name/value').text
+ method_description = ("Empirical method to estimate the direct operating costs (DOC) and indirect operating costs"
+ " (IOC) of an aircraft.")
+ child = ET.SubElement(parent, method_name)
+ child.set("description", method_description)
+
+ # Prepare ElementTree for export to module-specific XML.
+ prepare_element_tree_for_module_specific_export(root_of_results_file, method_specific_output_dict)
+
+ # Write all parameters to export file.
+ try:
+ # Ensure proper indentation.
+ ET.indent(root_of_results_file, space=" ", level=0)
+ # Write data to file.
+ xml_export_tree.write(path_to_results_file)
+ # Exception handling for operating system error.
+ except OSError:
+ runtime_output.error('Error: Writing to aircraft exchange file failed. Program aborted!')
+
+
+def prepare_element_tree_for_module_specific_export(root_of_results_file, specific_output_dict):
+ """ Prepare ElementTree for module-specific results export.
+
+ This function is responsible for preparing the ElementTree of the module-specific export file.
+ In summary, the code dynamically updates an XML structure based on a list of paths and a dictionary
+ ('specific_output_dict'). It ensures that the specified paths exist in the XML structure and creates the necessary
+ sub-elements along the way, setting attributes and text values as specified in 'specific_output_dict'.
+
+ :param ElementTree root_of_results_file: Root of method-specific export ElementTree
+ :param dict specific_output_dict: Dictionary containing method-specific output data
+ :return: None
+ """
+ # Extract 'list_of_paths' from 'specific_output_dict' and delete it from dictionary.
+ list_of_paths = specific_output_dict['list_of_paths']
+ del specific_output_dict['list_of_paths']
+ # Iterate over paths.
+ for current_path in list_of_paths:
+ # Check, if 'current_path' exists in XML structure and generate path and sub-elements if not.
+ if root_of_results_file.find(current_path) is None:
+ # Split path into path_parts using '/' as delimiter, excluding first empty part.
+ path_parts = current_path.split('/')[1:]
+ # Initialize 'path_to_check' with the root element ('.').
+ path_to_check = '.'
+ # Iterate over 'path_parts'.
+ for part in path_parts:
+ # Find parent element corresponding to current 'path_to_check'.
+ parent_path = root_of_results_file.find(path_to_check)
+ # Update 'path_to_check' by appending the current part.
+ path_to_check += ('/' + part)
+ # Check, if updated 'path_to_check' does not exist in the XML structure.
+ if root_of_results_file.find(path_to_check) is None:
+ # Check, if 'part' is in 'specific_output_dict'.
+ if specific_output_dict[part] is not None:
+ # Create sub-element.
+ new_node = ET.SubElement(parent_path, part)
+ # Add attributes (if necessary).
+ if 'attributes' in specific_output_dict[part]:
+ for key, value in specific_output_dict[part]['attributes'].items():
+ new_node.set(key, value)
+ # Add further sub-elements if defined.
+ if 'parameters' in specific_output_dict[part]:
+ current_path = root_of_results_file.find(path_to_check)
+ for key, value in specific_output_dict[part]['parameters'].items():
+ parameter_node = ET.SubElement(current_path, key)
+ parameter_node.text = str(value)
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/Icon\r"
new file mode 100644
index 0000000..e69de29
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/__pycache__/methodkerosene.cpython-311.pyc b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/__pycache__/methodkerosene.cpython-311.pyc
new file mode 100644
index 0000000000000000000000000000000000000000..803a0b986a463019e0f072d5c755c66b9725e9b8
GIT binary patch
literal 2179
zcmZ3^%ge>Uz`)?Kq9{#<oq^#ohy%k+P{wBo1_p-d3@Hpz3@MB$OgW5Ej48}53{gxe
zOu-DAELAqX`6;D2sR{)}`DK|YnR)37$%#41r8$WunfZANX{C9|AVx7%J~c%lsZyaN
zBUPcaIJHRcCCC!LWL6Lb#mo#03?Tfu4`MH43R4R69Hv^<8kPl6C8$&i%Q8j=hSiKP
zQAP%wDp`qEiD@QlFoPyrVhRfbgMUG4QDO<$r}@Pt3aP~<nYj?(=BAcp<fkYkCMV|?
zfrFwXUm+w^!6~&UCo@kWEx$-1JGCgkI5jU-w;;bfwJ0@3Au+QkxhOHMM30M0K|w(w
zBqOsJ9%u>$sYPk|MY+Y`0L#Z|EsA}hutnGjbrD{x!4@ay=cQ$)mx4T&pI5907K?UF
zNm0nnFG^L&%mcXt;>nEEqEtOSy;!i4kc?D?{L+$w(h`M~OmIvm7F8;!!@L;}k&6e(
zsVgMs=anR8=0Utulv-SxQ&Oyup9c0_GFnh3=A|fP7Aq8&6qP2Il!8MF7OG&2OY*_m
z((-e1^2<SSQJkESnwx3`mIQ?)HYX_9Dpac%Bo-y+rk11@#T%+yDU>DVl&0#yb%AtZ
z!$`V}V7h7{QDy};5bS-0g2a-H;`qe8l=!^F+|*(#1s6o1Kz$E(Yh`gsYA!^z0?4PX
zIjOm+c_kr5sj0<aw;&r@lwS%;ZQww}Wg=9K0@y7e&tVz^ii7yX<oMKz<c!3;^i+sZ
zut)(p3!xe8C`7UX2U4*@T2X#3Ji#i!%uz_o%t^&?G}yM>{FHb|!XneMTu9jhF$0=7
zG3?99PfyRxOV{(sPft%RQYb3TE6L1Fg(f{K1&}bvclk+KsmUdvawi3x6_XPSN=l1B
zGCBF_3c0Dp#fj;u#R{2u;DiOS8RD&?)RNMoJV*><OI8riW#;FB(mql&!;&~S+)zqI
zd?f+c&X;lw3=A(d7#J8dnQm#NWEQ0+m&C(MfOt@D0j0CN(!`wjl+@zP^t||j{LH+P
zTN0Uh*i~0q>5>hqOr!ns6`*BFW^Mr_wWg*hRHl|FXedD>U?HPdP^qM;7ptJ4pvicP
zwV)_7uSApW7C&0nxWxlavfyNWO8}f+kW%L@ey|841>NF9jo4cvFbknE4K}Elje&sy
zl7WA1(GM+7Eh^S8$w*Dh$uF<U&r8*J$xki?<+Ngb1A}<y{FGGvpwxo=;>?o#qRiA{
z{US$baqI#PQ~lJ6M38U6;T?}C==F<>lJ!eUlTyK19aQ}2r{)%97G)+U=IEow5|Xa?
zlG6Aja8;lWbGkl8(B0yP2*tyc6bUdeFmNz1Fcc>+FfcSQd{ATXX7pveVPW-wnNh~(
z0|TRs%>@>T4;&1v!q-_OF0n{lkPN-Z5_W|p>;g;J4HhAoV8BI|z$+|)7gz$31Q9A9
zaLZp{k^c;;MKzgkvB$@!<R{0+-(oJVECxGaB}0)Q0|P@5KLZ29FAf_>{;(?&Wnf?c
nRlUW!3=9k(m>C%vZ!kDrU~qcCz|{bTAGo9$6+SRv5@6#1(b2dy
literal 0
HcmV?d00001
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/methodkerosene.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/methodkerosene.py
new file mode 100644
index 0000000..7781cf0
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/methodkerosene.py
@@ -0,0 +1,35 @@
+"""Module providing calculation functions provided by the user."""
+# Import standard modules.
+import sys
+
+# Import own modules.
+
+
+def method_kerosene(paths_and_names, routing_dict, dict_ac_exchange, dict_mod_config, runtime_output):
+ """Operating cost estimation method according to TU Berlin for kerosene-powered aircraft.
+
+ This function performs the operating cost estimation according to the TU Berlin method for kerosene-powered aircraft
+ configurations.
+ [Add more information here...]
+ The output dictionary 'kerosene_output_dict' contains the results of the cost estimation and is structured according
+ to the following scheme:
+ kerosene_output_dict = {'parameter_1': value,
+ 'parameter_2': value}
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing routing parameters
+ :param dict dict_ac_exchange: Dict containing parameters and according values from aircraft exchange file
+ :param dict dict_mod_config: Dict containing parameters and according values from module configuration file
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :return dict kerosene_output_dict: Dictionary containing results from calculation for kerosene-powered aircraft
+ """
+
+ kerosene_output_dict = {'direct_operating_costs_annual_design_point': 30,
+ 'indirect_operating_costs': 40}
+
+ # Calculate costs.
+ runtime_output.print('----------------------------------------------------------')
+ runtime_output.print('[No method implemented yet ("methodkerosene.py").] ')
+ runtime_output.print('----------------------------------------------------------')
+
+ return kerosene_output_dict
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/liquid_hydrogen/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/liquid_hydrogen/Icon\r"
new file mode 100644
index 0000000..e69de29
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/liquid_hydrogen/methodliquidhydrogen.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/liquid_hydrogen/methodliquidhydrogen.py
new file mode 100644
index 0000000..7a33a60
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/liquid_hydrogen/methodliquidhydrogen.py
@@ -0,0 +1,34 @@
+"""Module providing calculation functions provided by the user."""
+# Import standard modules.
+import sys
+
+# Import own modules.
+
+
+def method_liquid_hydrogen(paths_and_names, routing_dict, dict_ac_exchange, dict_mod_config, runtime_output):
+ """Operating cost estimation method for liquid hydrogen (LH2)-powered aircraft.
+
+ This function performs the operating cost estimation for liquid hydrogen-powered aircraft configurations.
+ [Add more information here...]
+ The output dictionary 'liquid_hydrogen_output_dict' contains the results of the cost estimation and is structured
+ according to the following scheme:
+ liquid_hydrogen_output_dict = {'parameter_1': value,
+ 'parameter_2': value}
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing routing parameters
+ :param dict dict_ac_exchange: Dict containing parameters and according values from aircraft exchange file
+ :param dict dict_mod_config: Dict containing parameters and according values from module configuration file
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :return dict liquid_hydrogen_output_dict: Dictionary containing results from calculation for LH2-powered aircraft
+ """
+
+ liquid_hydrogen_output_dict = {'direct_operating_costs_annual_design_point': 30,
+ 'indirect_operating_costs': 40}
+
+ # Calculate costs.
+ runtime_output.print('----------------------------------------------------------')
+ runtime_output.print('[No method implemented yet ("methodliquidhydrogen.py").] ')
+ runtime_output.print('----------------------------------------------------------')
+
+ return liquid_hydrogen_output_dict
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/usermethoddatapreparation.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/usermethoddatapreparation.py
new file mode 100644
index 0000000..67d2017
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/usermethoddatapreparation.py
@@ -0,0 +1,211 @@
+"""Module providing functions for the preparation of user data."""
+
+
+def user_method_data_input_preparation(routing_dict):
+ """Prepare necessary input data for the user method from aircraft exchange and module configuration files.
+
+ In this function, the user is responsible for preparing the data needed for the user method. Relevant general data
+ are obtained from the aircraft exchange file and calculation specific parameter from the module configuration file.
+ The user must submit the data in the following format:
+ dict = {'parameter_name': [path to parameter node, expected data type], ...}
+
+ :param dict routing_dict: Dictionary containing information on necessary data from module configuration file
+ :returns:
+ - dict data_to_extract_from_aircraft_exchange_dict: Dictionary containing parameter name, path to parameter,
+ and expected data type of parameters to be extracted from aircraft exchange file
+ - dict data_to_extract_from_module_configuration_dict: Dictionary containing parameter name, path to parameter,
+ and expected data type of parameters to be extracted from module configuration file
+ """
+
+ """Aircraft exchange file."""
+ # Enter all parameters to be extracted from the aircraft exchange file.
+ path_to_adapt = './requirements_and_specifications/everything_the_DOC_heart_desires/'
+ data_to_extract_from_aircraft_exchange_dict = {
+ 'altitude_cruise': [path_to_adapt + 'altitude_cruise', float],
+ 'm_cargo_design': ['./analysis/mission/design_mission/cargo_mass', float],
+ 'm_cargo_study': ['./analysis/mission/study_mission/cargo_mass', float],
+ 'm_luggage': [path_to_adapt + '/m_luggage', float],
+ 'm_operating_empty': ['./analysis/masses_cg_inertia/operating_mass_empty/mass_properties/mass', float],
+ 'm_passenger': [path_to_adapt + '/m_passenger', float],
+ 'm_payload_design': ['./analysis/mission/design_mission/payload', float],
+ 'm_payload_max': ['./analysis/masses_cg_inertia/maximum_payload_mass/mass_properties/mass', float],
+ 'm_payload_study': ['./analysis/mission/study_mission/payload', float],
+ 'm_payload_at_max_fuel': ['./assessment/performance/range/payload_maximum_fuel_at_maximum_take_off_mass',
+ float],
+ 'm_takeoff_design': ['./analysis/mission/design_mission/take_off_mass', float],
+ 'm_takeoff_max': ['./analysis/masses_cg_inertia/maximum_takeoff_mass/mass_properties/mass', float],
+ 'm_takeoff_study': [path_to_adapt + 'm_takeoff_study', float],
+ 'mach_cruise': [path_to_adapt + 'mach_cruise', float],
+ 'n_cabin_crew_members': [path_to_adapt + 'n_cabin_crew_members', float],
+ 'n_cockpit_crew_members': [path_to_adapt + 'n_cockpit_crew_members', float],
+ 'n_engines': [path_to_adapt + 'n_engines', float],
+ 'n_passengers_per_class': [path_to_adapt + 'pax_per_class', str],
+ 'range_at_max_fuel': ['./assessment/performance/range/range_max_fuel_at_maximum_take_off_mass', float],
+ 'range_at_max_payload': ['./assessment/performance/range/range_max_payload_at_maximum_take_off_mass', float],
+ 'range_ferry': ['./assessment/performance/range/range_maximum_fuel_empty', float],
+ 'static_thrust_per_engine': [path_to_adapt + 'static_thrust_per_engine', float],
+ 'stage_length_design': ['./analysis/mission/design_mission/range', float],
+ 'stage_length_study': ['./analysis/mission/study_mission/range', float],
+ 'seat_load_factor_design': [path_to_adapt + 'seat_load_factor_design', float],
+ 'seat_load_factor_study': [path_to_adapt + 'seat_load_factor_design', float],
+ 'flight_time_design': [path_to_adapt + 'flight_time_design', float],
+ 'flight_time_study': [path_to_adapt + 'flight_time_study', float],
+ 'flights_per_year_design': [path_to_adapt + 'flights_per_year_design', float],
+ 'flights_per_year_study': [path_to_adapt + 'flights_per_year_study', float]
+ }
+
+ """Module configuration file."""
+ # Enter all general parameters to be extracted from the module configuration file. 'general parameters' means
+ # parameters that do not differ according to the user layer. It should be noted that 'tmp_general' is only used to
+ # shorten the path information in the 'general_data_to_extract_from_module_configuration_dict'.
+ tmp_general = ('./program_settings/configuration[@ID="tube_and_wing"]/fidelity[@ID="empirical"]/'
+ + 'operating_cost_estimation_tu_berlin/general_direct_operating_costs_parameter')
+ general_data_to_extract_from_module_configuration_dict = {
+ 'annual_lay_days_maintenance':
+ [tmp_general + '/maintenance/annual_lay_days_maintenance', float],
+ 'annual_lay_days_overhaul':
+ [tmp_general + '/flight_cycles/annual_lay_days_overhaul', float],
+ 'annual_lay_days_reserve':
+ [tmp_general + '/flight_cycles/annual_lay_days_reserve', float],
+ 'air_traffic_control_price_factor_design':
+ [tmp_general + '/air_traffic_control/air_traffic_control_price_factor_design', float],
+ 'air_traffic_control_price_factor_study':
+ [tmp_general + '/air_traffic_control/air_traffic_control_price_factor_study', float],
+ 'airframe_repair_costs_per_flight':
+ [tmp_general + '/maintenance/airframe_repair_costs_per_flight', float],
+ 'block_time_per_flight':
+ [tmp_general + '/flight_cycles/block_time_per_flight', float],
+ 'cost_burden':
+ [tmp_general + '/maintenance/cost_burden', float],
+ 'daily_night_curfew_time':
+ [tmp_general + '/flight_cycles/daily_night_curfew_time', float],
+ 'depreciation_period':
+ [tmp_general + '/capital/depreciation_period', float],
+ 'fees_handling':
+ [tmp_general + '/handling/fees_handling', float],
+ 'fees_landing':
+ [tmp_general + '/landing/fees_landing', float],
+ 'potential_annual_operation_time':
+ [tmp_general + '/flight_cycles/potential_annual_operation_time', float],
+ 'price_per_operating_empty_mass':
+ [tmp_general + '/capital/price_per_operating_empty_mass', float],
+ 'rate_inflation':
+ [tmp_general + '/miscellaneous/rate_inflation', float],
+ 'rate_insurance':
+ [tmp_general + '/capital/rate_insurance', float],
+ 'rate_interest':
+ [tmp_general + '/capital/rate_interest', float],
+ 'rate_labor':
+ [tmp_general + '/maintenance/rate_labor', float],
+ 'residual_value_factor':
+ [tmp_general + '/capital/residual_value_factor', float],
+ 'revenue_per_freight_km_design':
+ [tmp_general + '/related_direct_operating_costs/revenue_per_freight_km_design', float],
+ 'revenue_per_freight_km_study':
+ [tmp_general + '/related_direct_operating_costs/revenue_per_freight_km_study', float],
+ 'salary_variation':
+ [tmp_general + '/crew/salary_variation', bool],
+ 'seat_load_factor_design':
+ [tmp_general + '/miscellaneous/seat_load_factor_design', float],
+ 'seat_load_factor_study':
+ [tmp_general + '/miscellaneous/seat_load_factor_study', float]
+ }
+
+ # Enter all specific parameters to be extracted from the module configuration file. 'specific parameters' means
+ # parameters that differ according to the user layer. It should be noted that 'tmp_specific' is only used to
+ # shorten the path information in the 'specific_data_to_extract_from_module_configuration_dict'.
+ tmp_specific = ('./program_settings/configuration[@ID="tube_and_wing"]/fidelity[@ID="empirical"]/'
+ + 'operating_cost_estimation_tu_berlin')
+ specific_data_to_extract_from_module_configuration_dict = {
+ 'fuel_price': [tmp_specific + '/fuel_type[@ID="' + routing_dict['user_layer'] + '"]/fuel_price', float],
+ 'factor_engine_maintenance':
+ [tmp_specific + '/fuel_type[@ID="' + routing_dict['user_layer'] + '"]/factor_engine_maintenance', float],
+ 'ratio_operating_empty_mass':
+ [tmp_specific + '/fuel_type[@ID="' + routing_dict['user_layer'] + '"]/ratio_operating_empty_mass', float]
+ }
+
+ # Merge module configuration dictionaries.
+ data_to_extract_from_module_configuration_dict = \
+ general_data_to_extract_from_module_configuration_dict | specific_data_to_extract_from_module_configuration_dict
+
+ return data_to_extract_from_aircraft_exchange_dict, data_to_extract_from_module_configuration_dict
+
+
+def user_method_data_output_preparation(data_dict):
+ """Prepare user-specific output data based on the calculation method results.
+
+ This function is responsible for preparing the user-specific output data based on the results of the calculation
+ method. The 'data_dict' input parameter contains the results of the module execution.
+ The data for the key parameters output must be specified in the following format in order to be written correctly
+ to the aircraft exchange file by the 'write_key_data_to_aircraft_exchange_file' function in the following step:
+ dict = {'parameter_name': [path to parameter node, value, name (if needed)], ...}
+ Important notes:
+ (1) It should be noted that only key parameters may be written that have been previously defined by the module
+ manager.
+ (2) Attention must be paid to the proper path specifications, otherwise warnings may be issued or, in the worst
+ case, errors may occur subsequently resulting in the write process and consequently the entire program being
+ aborted.
+ (3) If the path specifications contain IDs, these must start at '0' and be defined in ascending order without
+ gaps.
+ For the method-specific output, a path list and a dictionary is necessary to properly write the data to the
+ method-specific XML file.
+ the dictionary must be specified in the following format:
+ dict = ...
+ Note: If the user wants to export data from the design and study mission, two path lists and dictionaries are
+ necessary.
+
+ :param dict data_dict: Dictionary containing the results of the module execution
+ :returns:
+ - dict key_output_dict: Output dictionary containing key parameters that are written to aircraft XML file
+ - dict method_specific_output_dict: Dictionary containing specific parameters that are written to
+ method-specific output XML
+ """
+
+ """Key parameters output."""
+ doc_path = './assessment/operating_cost_estimation_tu_berlin/direct_operating_costs/'
+ ioc_path = './assessment/operating_cost_estimation_tu_berlin/indirect_operating_costs/'
+
+ key_output_dict = {
+ # Direct operating costs shares.
+ 'direct_operating_costs_annual':
+ [doc_path + 'direct_operating_costs_annual',
+ data_dict['direct_operating_costs_annual_design_point']],
+ # Indirect operating costs shares.
+ 'indirect_operating_costs_annual':
+ [ioc_path + 'indirect_operating_costs_annual',
+ data_dict['indirect_operating_costs']]
+ }
+
+ """Method-specific output."""
+ # Define specific output paths and dict for design mission.
+ tmp_path = './calculation_results/operating_cost_estimation_tu_berlin/design_mission/'
+
+ paths_to_specific_design_outputs_list = [
+ tmp_path + 'direct_operating_costs/direct_operating_costs_per_year',
+ tmp_path + 'indirect_operating_costs'
+ ]
+
+ method_specific_output_dict = {
+ 'operating_cost_estimation_tu_berlin': {},
+ 'design_mission': {
+ 'attributes': {'description': 'Cost estimation results of the design mission'}},
+ 'direct_operating_costs': {
+ 'attributes': {'description': 'Direct operating costs'}},
+ # Direct operating costs.
+ 'direct_operating_costs_per_year': {
+ 'attributes': {'description': 'Direct operating costs per year at design point (sum of route dependent and '
+ 'route independent costs)'},
+ 'parameters': {
+ 'value': data_dict['direct_operating_costs_annual_design_point'],
+ 'unit': 'EUR'}},
+ # Indirect operating costs.
+ 'indirect_operating_costs': {
+ 'attributes': {'description': 'Indirect operating costs'},
+ 'parameters': {
+ 'value': data_dict['indirect_operating_costs'],
+ 'unit': 'EUR'}},
+ # List
+ 'list_of_paths': paths_to_specific_design_outputs_list
+ }
+
+ return key_output_dict, method_specific_output_dict
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/version.txt b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/version.txt
new file mode 100644
index 0000000..50aea0e
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/version.txt
@@ -0,0 +1 @@
+2.1.0
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/CSR-02.xml b/docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/CSR-02.xml
new file mode 100644
index 0000000..2582b9d
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/CSR-02.xml
@@ -0,0 +1,4832 @@
+<aircraft_exchange_file>
+ <requirements_and_specifications description="Requirements and specifications">
+ <general description="General information on requirements and specifications">
+ <type description="Aircraft type">
+ <value>CeRAS</value>
+ </type>
+ <model description="Model - Version">
+ <value>CSR-02</value>
+ </model>
+ </general>
+ <design_specification description="Design specification">
+ <configuration description="Configuration information">
+ <configuration_type description="aircraft configuration: tube_and_wing / blended_wing_body">
+ <value>tube_and_wing</value>
+ </configuration_type>
+ <undercarriage_definition description="Design description of the undercarriage.">
+ <main_gear_mounting description="Mounting position of the main landing gear: wing_mounted / fuselage_mounted.">
+ <value>wing_mounted</value>
+ </main_gear_mounting>
+ </undercarriage_definition>
+ </configuration>
+ <propulsion description="Propulsion information">
+ <propulsor ID="0" description="Specific propulsor information">
+ <mounting_position description="positions: under_wing_left / under_wing_right / over_wing_left / over_wing_right / on_fuselage_left / on_fuselage_right / in_fuselage_rear">
+ <value>under_wing_left</value>
+ </mounting_position>
+ <energy_carrier description="Energy type: kerosene / liquid_hydrogen / battery / saf / hybrid (e.g, kerosene+liquid_hydrogen)">
+ <value>kerosene</value>
+ </energy_carrier>
+ <degree_of_hybridization description="">
+ <value>0.5</value>
+ </degree_of_hybridization>
+ </propulsor>
+ <propulsor ID="1" description="Specific propulsor information">
+ <mounting_position description="positions: under_wing_left / under_wing_right / over_wing_left / over_wing_right / on_fuselage_left / on_fuselage_right / in_fuselage_rear">
+ <value>under_wing_left</value>
+ </mounting_position>
+ <energy_carrier description="Energy type: kerosene / liquid_hydrogen / battery / saf / hybrid (e.g, kerosene+liquid_hydrogen)">
+ <value>kerosene</value>
+ </energy_carrier>
+ <degree_of_hybridization description="">
+ <value>0.5</value>
+ </degree_of_hybridization>
+ </propulsor>
+ </propulsion>
+ </design_specification>
+ <requirements description="Aircraft design requirements">
+ <top_level_aircraft_requirements description="Top level aircraft requirements (TLAR)">
+ <maximum_approach_speed description="Maximum allowed approach speed.">
+ <value>71</value>
+ <unit>m/s</unit>
+ <lower_boundary>50</lower_boundary>
+ <upper_boundary>90</upper_boundary>
+ </maximum_approach_speed>
+ <pavement_classification_number description="Runway pavment classification number (PCN) - limits the maximum allowed aircraft classification number of undercarriage.">
+ <value>55</value>
+ <unit>1</unit>
+ <lower_boundary>5</lower_boundary>
+ <upper_boundary>120</upper_boundary>
+ </pavement_classification_number>
+ </top_level_aircraft_requirements>
+ <additional_requirements description="Additional requirements">
+ </additional_requirements>
+ </requirements>
+ <everything_the_DOC_heart_desires>
+ <altitude_cruise>
+ <value>10058.4</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>m</unit>
+ </altitude_cruise>
+ <m_passenger>
+ <value>75</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>kg</unit>
+ </m_passenger>
+ <m_luggage>
+ <value>15.72</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>kg</unit>
+ </m_luggage>
+ <n_cabin_crew_members>
+ <value>4</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>kg</unit>
+ </n_cabin_crew_members>
+ <n_cockpit_crew_members>
+ <value>2</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>kg</unit>
+ </n_cockpit_crew_members>
+ <n_engines>
+ <value>2</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>kg</unit>
+ </n_engines>
+ <pax_per_class>
+ <value>0/0/0/12/138</value>
+ <unit>1</unit>
+ </pax_per_class>
+ <static_thrust_per_engine>
+ <value>128.855268</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>kg</unit>
+ </static_thrust_per_engine>
+ <m_takeoff_study>
+ <value>62560.48325</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>kg</unit>
+ </m_takeoff_study>
+ <mach_cruise>
+ <value>0.82</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>1</unit>
+ </mach_cruise>
+ <seat_load_factor_design>
+ <value>1.0</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>1</unit>
+ </seat_load_factor_design>
+ <seat_load_factor_study>
+ <value>0.8</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>1</unit>
+ </seat_load_factor_study>
+ <flights_per_year_design>
+ <value>1289</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>1</unit>
+ </flights_per_year_design>
+ <flights_per_year_study>
+ <value>2508</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>1</unit>
+ </flights_per_year_study>
+ <flight_time_design>
+ <value>2.83</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>1</unit>
+ </flight_time_design>
+ <flight_time_study>
+ <value>0.57</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <unit>1</unit>
+ </flight_time_study>
+ </everything_the_DOC_heart_desires>
+ </requirements_and_specifications>
+ <sizing_point>
+ <wing_loading description="Maximum takeoff mass (MTOM) divided by wing area (Sref)" tool_evel="1">
+ <value>0</value>
+ <unit>"kg/m^2"</unit>
+ </wing_loading>
+ <thrust_to_weight description="Total thrust (kN) divided by maximum aircraft weight (kN)" tool_evel="1">
+ <value>0</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ <unit>"1"</unit>
+ </thrust_to_weight>
+ <MTOM description="Maximum takeoff mass" tool_evel="1">
+ <value>0</value>
+ <unit>"kg"</unit>
+ </MTOM>
+ <OME description="Operating mass empty" tool_evel="1">
+ <value>0</value>
+ <unit>"kg"</unit>
+ </OME>
+ </sizing_point>
+ <component_design>
+ <mission_files description="Path and name of xml files containing the flight phase data" tool_level="0">
+ <design_mission_file description="Path and name of the design mission xml">
+ <value>0</value>
+ </design_mission_file>
+ <study_mission_file description="Path and name of the study mission xml">
+ <value>0</value>
+ </study_mission_file>
+ </mission_files>
+ <global_reference_point>
+ <reference_component description="">
+ <value />
+ </reference_component>
+ <x_position description="">
+ <value />
+ <unit />
+ </x_position>
+ <y_position description="">
+ <value />
+ <unit />
+ </y_position>
+ <z_position description="">
+ <value />
+ <unit />
+ </z_position>
+ </global_reference_point>
+ <wing description="wing component" tool_level="0">
+ <position description="position of wing (most forward position of part composition at y = 0)">
+ <x description="x position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </position>
+ <mass_properties description="mass_properties of component wing">
+ <mass description="component mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="component inertia refered to center of gravity">
+ <j_xx description="inertia component in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia component in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia component in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia component in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia component in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia component in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia component in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia component in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia component in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="component center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ <specific>
+ <geometry>
+ <aerodynamic_surface description="aerodynamic surface" ID="0">
+ <name description="name of aerodynamic surface">
+ <value>main_wing</value>
+ </name>
+ <position description="reference position in global coordinates">
+ <x description="x position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </position>
+ <parameters description="aerodynamic surface parameters">
+ <direction description="unit vector according to global coordinate system for direction applied at position">
+ <x description="x direction of unit vector">
+ <value>0.0</value>
+ <unit>1</unit>
+ <lower_boundary>-1.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </x>
+ <y description="y direction of unit vector">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>-1.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </y>
+ <z description="z direction of unit vector">
+ <value>0.0</value>
+ <unit>1</unit>
+ <lower_boundary>-1.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </z>
+ </direction>
+ <symmetric description="symmetric to x-z plane (global) aerodynamic surface">
+ <value>true</value>
+ </symmetric>
+ <sections description="sections">
+ <section description="section" ID="0">
+ <chord_origin description="origin of chord (local)">
+ <x description="x position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </chord_origin>
+ <chord_length description="length of chord">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </chord_length>
+ <geometric_twist description="geometric twist at leading edge">
+ <value>0.0</value>
+ <unit>rad</unit>
+ <lower_boundary>-</lower_boundary>
+ <upper_boundary />
+ </geometric_twist>
+ <profile description="profile (data normalized on chord)">
+ <name>
+ <value>naca0012</value>
+ </name>
+ </profile>
+ </section>
+ </sections>
+ <spars description="spars">
+ <spar description="front spar" ID="0">
+ <position description="chord relative position of control device">
+ <inner_position description="relative inner position">
+ <spanwise description="relative spanwise position">
+ <value>0.</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </inner_position>
+ <outer_position description="relative outer position">
+ <spanwise description="relative spanwise position">
+ <value>0.2</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </outer_position>
+ </position>
+ </spar>
+ <spar description="rear spar" ID="1">
+ <position description="chord relative position of control device">
+ <inner_position description="relative inner position">
+ <spanwise description="relative spanwise position">
+ <value>0.</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </inner_position>
+ <outer_position description="relative outer position">
+ <spanwise description="relative spanwise position">
+ <value>0.2</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </outer_position>
+ </position>
+ </spar>
+ </spars>
+ <control_devices description="control devices">
+ <control_device description="control device" ID="0">
+ <type>
+ <value>aileron</value>
+ </type>
+ <deflection description="maximum positive and negative deflection of control device">
+ <full_negative_deflection description="full negative deflection">
+ <value>-25.0</value>
+ <unit>deg</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </full_negative_deflection>
+ <full_positive_deflection description="full positive deflection">
+ <value>25.0</value>
+ <unit>deg</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </full_positive_deflection>
+ </deflection>
+ <position description="chord relative position of control device">
+ <inner_position description="relative inner position">
+ <spanwise description="relative spanwise position">
+ <value>0.2</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </inner_position>
+ <outer_position description="relative outer position">
+ <spanwise description="relative spanwise position">
+ <value>0.2</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </outer_position>
+ </position>
+ </control_device>
+ </control_devices>
+ </parameters>
+ <mass_properties description="mass_properties of aerodynamic surface">
+ <mass description="component mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="component inertia refered to center of gravity">
+ <j_xx description="inertia component in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia component in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia component in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia component in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia component in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia component in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia component in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia component in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia component in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="component center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </aerodynamic_surface>
+ </geometry>
+ </specific>
+ </wing>
+ <fuselage description="Geometric description of the aircraft fuselages" tool_level="0">
+ <position description="Position of the fuselages with regard to the global reference point.">
+ <x_position description="Distance in x direction with regard to the global reference point. (fuselage nose point)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </x_position>
+ <y_position description="Distance in y direction with regard to the global reference point. (fuselage nose point)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </y_position>
+ <z_position description="Distance in z direction with regard to the global reference point. (distance to fuselage center line)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </position>
+ <mass_properties description="Mass properties of the fuselages.">
+ <mass description="Mass of the total fuselages.">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="Inertia of the total fuselages with regard to the total center of gravity.">
+ <j_xx description="Inertia of the total fuselages in x.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="Inertia of the total fuselages in y.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="Inertia of the total fuselages in z.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="Inertia of the total fuselages in xy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="Inertia of the total fuselages in xz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="Inertia of the total fuselages in yx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="Inertia of the total fuselages in yz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="Inertia of the total fuselages in zx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="Inertia of the total fuselages in zy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="Center of gravity of the total fuselages.">
+ <x_position description="Center of gravity in x-direction with regard to the global reference point. (total fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>50</upper_boundary>
+ </x_position>
+ <y_position description="Center of gravity in y-direction with regard to the global reference point. (total fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </y_position>
+ <z_position description="Center of gravity in z-direction with regard to the global reference point. (total fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </center_of_gravity>
+ </mass_properties>
+ <specific>
+ <geometry>
+ <geometry_file_name>
+ <value>geometryData/fuselage.dat</value>
+ </geometry_file_name>
+ <fuselage ID="0" description="Geometrical description of one entire fuselage.">
+ <name description="Name of the fuselage.">
+ <value>center_fuselage</value>
+ </name>
+ <position description="Position of one entire fuselage with regard to the global reference point.">
+ <x_position description="Distance in x direction with regard to the global reference point. (fuselage nose point)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </x_position>
+ <y_position description="Distance in y direction with regard to the global reference point. (fuselage nose point)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-25</lower_boundary>
+ <upper_boundary>25</upper_boundary>
+ </y_position>
+ <z_position description="Distance in z direction with regard to the global reference point. (distance to fuselage center line)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </position>
+ <mass_properties description="Mass properties of one entire fuselage.">
+ <mass description="Mass of one entire fuslege.">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100000</upper_boundary>
+ </mass>
+ <inertia description="Inertia of one entire fuselage with regard to his center of gravity.">
+ <j_xx description="Inertia of one entire fuselage in x.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="Inertia of one entire fuselage in y.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="Inertia of one entire fuselage in z.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="Inertia of one entire fuselage in xy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="Inertia of one entire fuselage in xz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="Inertia of one entire fuselage in yx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="Inertia of one entire fuselage in yz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="Inertia of one entire fuselage in zx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="Inertia of one entire fuselage in zy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="Center of gravity of one entire fuselage.">
+ <x_position description="Center of gravity in x-direction with regard to the global reference point. (entire fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>50</upper_boundary>
+ </x_position>
+ <y_position description="Center of gravity in y-direction with regard to the global reference point. (entire fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-25</lower_boundary>
+ <upper_boundary>25</upper_boundary>
+ </y_position>
+ <z_position description="Center of gravity in z-direction with regard to the global reference point. (entire fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </center_of_gravity>
+ </mass_properties>
+ <fuselage_sections description="Geometrical description of the fuselage sections of one entire fuselage">
+ <section ID="0" description="Geometrical description of one fuselage section.">
+ <name description="Name of the fuselage section.">
+ <value>section_1</value>
+ </name>
+ <origin description="Origin of fuselage section (local).">
+ <x_position description="Distance in x direction with regard to the global reference point.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>75</upper_boundary>
+ </x_position>
+ <y_position description="Distance in y direction with regard to the global reference point.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-25</lower_boundary>
+ <upper_boundary>25</upper_boundary>
+ </y_position>
+ <z_position description="Distance in z direction with regard to the global reference point.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </origin>
+ <upper_hight description="Height of the upper half of the fuselage section.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </upper_hight>
+ <lower_hight description="Height of the lower half of the fuselage section.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </lower_hight>
+ <width description="Width of the fuselage section.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </width>
+ <chord_length description="Maximum length of the fuselage section for bwb configuration.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>70</upper_boundary>
+ </chord_length>
+ </section>
+ </fuselage_sections>
+ <fuselage_accommodation>
+ <position description="Position of the payload tubes with regard to the global reference point.">
+ <x_position description="Distance in x direction with regard to the global reference point. (center payload tube starting point)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </x_position>
+ <y_position description="Distance in y direction with regard to the global reference point. (center payload tube starting point)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </y_position>
+ <z_position description="Distance in z direction with regard to the global reference point. (distance to fuselage center line)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </position>
+ <mass_properties description="Mass properties of the payload tubes of one entire fuselage.">
+ <mass description="Mass of the payload tubes of one entire fuslege.">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100000</upper_boundary>
+ </mass>
+ <center_of_gravity description="Center of gravity of the payload tubes of one entire fuselage.">
+ <x_position description="Center of gravity in x-direction with regard to the global reference point. (all payload tubes of one entire fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>50</upper_boundary>
+ </x_position>
+ <y_position description="Center of gravity in y-direction with regard to the global reference point. (all payload tubes of one entire fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </y_position>
+ <z_position description="Center of gravity in z-direction with regard to the global reference point. (all payload tubes of one entire fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </center_of_gravity>
+ </mass_properties>
+ <number_of_payload_tubes description="Number of payload tubes of one entire fuselage.">
+ <value>1</value>
+ <unit>1</unit>
+ <lower_boundary>1</lower_boundary>
+ <upper_boundary>7</upper_boundary>
+ </number_of_payload_tubes>
+ <payload_tube ID="0" description="Geometrical description of one payload tube of the fuselage.">
+ <name description="Name of the payload tube.">
+ <value>center_payload_tube</value>
+ </name>
+ <payload_tube_reference_points description="Payload tube center reference points in x, y and z-direction refered to fuselage nose point.">
+ <front_reference_points Desc="Reference points in the front of payload tube.">
+ <x_position Desc="Payload tube reference point in x-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x_position>
+ <y_position Desc="Payload tube reference point in y-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y_position>
+ <z_position Desc="Payload tube reference point in z-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z_position>
+ <upper_z_position Desc="Upper payload tube reference point in z-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </upper_z_position>
+ <lower_z_position Desc="Lower payload tube reference point in z-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </lower_z_position>
+ </front_reference_points>
+ <aft_reference_points Desc="Reference points in the aft of payload tube.">
+ <x_position Desc="Payload tube reference point in x-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x_position>
+ <y_position Desc="Payload tube reference point in y-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y_position>
+ <z_position Desc="Payload tube reference point in z-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z_position>
+ <upper_z_position Desc="Upper payload tube reference point in z-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </upper_z_position>
+ <lower_z_position Desc="Lower payload tube reference point in z-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </lower_z_position>
+ </aft_reference_points>
+ </payload_tube_reference_points>
+ <payload_tube_wall_reference_points description="Payload tube wall reference points in x, y and z-direction refered to fuselage nose point.">
+ <front_reference_points Desc="Wall reference points in the front of payload tube.">
+ <x_position Desc="Wall reference point in x-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x_position>
+ <left_y_position Desc="Left wall reference point in y-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </left_y_position>
+ <right_y_position Desc="Right wall reference point in y-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </right_y_position>
+ <z_position Desc="Wall reference point in z-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z_position>
+ </front_reference_points>
+ <aft_reference_points Desc="Wall reference points in the aft of payload tube.">
+ <x_position Desc="Wall reference point in x-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x_position>
+ <left_y_position Desc="Left wall reference point in y-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </left_y_position>
+ <right_y_position Desc="Right wall reference point in y-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </right_y_position>
+ <z_position Desc="Wall reference point in z-direction">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z_position>
+ </aft_reference_points>
+ </payload_tube_wall_reference_points>
+ <payload_tube_structural_wall_thickness description="Structural wall thickness of the paylaod tube.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </payload_tube_structural_wall_thickness>
+ <payload_tube_water_volume description="Total water volume of one entire paylaod tube.">
+ <value>0</value>
+ <unit>m^3</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>infr</upper_boundary>
+ </payload_tube_water_volume>
+ <number_of_payload_decks description="Number of payload decks of one entire fuselage.">
+ <value>1</value>
+ <unit>1</unit>
+ <lower_boundary>1</lower_boundary>
+ <upper_boundary>3</upper_boundary>
+ </number_of_payload_decks>
+ <payload_deck ID="0" description="Geometrical description of the payload decks in one payload tube.">
+ <name description="Name of the payload deck.">
+ <value>passenger_deck</value>
+ </name>
+ <position description="Position of the payload deck with regard to the global reference point.">
+ <x_position description="Distance in x direction with regard to the global reference point. (payload deck starting point)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </x_position>
+ <y_position description="Distance in y direction with regard to the global reference point. (payload deck starting point)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </y_position>
+ <z_position description="Distance in z direction with regard to the global reference point. (distance to fuselage center line)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </position>
+ <mass_properties description="Mass properties of the payload deck of one entire payload tube.">
+ <mass description="Mass of the payload deck of one entire paylaod tube.">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100000</upper_boundary>
+ </mass>
+ <center_of_gravity description="Center of gravity of the payload tubes of one entire fuselage.">
+ <x_position description="Center of gravity in x-direction with regard to the global reference point. (all payload tubes of one entire fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>50</upper_boundary>
+ </x_position>
+ <y_position description="Center of gravity in y-direction with regard to the global reference point. (all payload tubes of one entire fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </y_position>
+ <z_position description="Center of gravity in z-direction with regard to the global reference point. (all payload tubes of one entire fuselage)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </center_of_gravity>
+ </mass_properties>
+ <payload_deck_area description="Total floor area of the paylaod deck.">
+ <value>0</value>
+ <unit>m^2</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </payload_deck_area>
+ <payload_deck_water_volume description="Total water volume of the paylaod deck.">
+ <value>0</value>
+ <unit>m^3</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </payload_deck_water_volume>
+ <payload_deck_length description="Total length of the paylaod deck.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100</upper_boundary>
+ </payload_deck_length>
+ <payload_deck_height description="Maximum standing height of the paylaod deck.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>3</upper_boundary>
+ </payload_deck_height>
+ <payload_deck_top_width description="Width on the top of the paylaod deck.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </payload_deck_top_width>
+ <payload_deck_bottom_width description="Width on the bottom of the paylaod deck.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </payload_deck_bottom_width>
+ <payload_deck_required_power description="Required power of the payload deck.">
+ <value>0</value>
+ <unit>W</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </payload_deck_required_power>
+ <number_of_payload_deck_compartments description="Number of paylaod compartments of the payload deck.">
+ <value>1</value>
+ <unit>1</unit>
+ <lower_boundary>1</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </number_of_payload_deck_compartments>
+ <payload_compartment ID="0" description="Geometrical description of the payload compartment of one payload deck.">
+ <name description="Name of the payload compartment of the payload deck.">
+ <value>front_compartment</value>
+ </name>
+ <position description="Position of the payload compartment with regard to the global reference point.">
+ <x_position description="Distance in x direction with regard to the global reference point. (payload compartment starting point)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>100</upper_boundary>
+ </x_position>
+ <y_position description="Distance in y direction with regard to the global reference point. (payload compartment starting point)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-25</lower_boundary>
+ <upper_boundary>25</upper_boundary>
+ </y_position>
+ <z_position description="Distance in z direction with regard to the global reference point. (distance compartment fuselage center line)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </position>
+ <payload_compartment_area description="Total floor area of the payload compartment.">
+ <value>0</value>
+ <unit>m^2</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </payload_compartment_area>
+ <payload_compartment_water_volume description="Total water volume of the paylaod compartment.">
+ <value>0</value>
+ <unit>m^3</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </payload_compartment_water_volume>
+ <payload_compartment_length description="Total length of the paylaod compartment.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100</upper_boundary>
+ </payload_compartment_length>
+ </payload_compartment>
+ </payload_deck>
+ </payload_tube>
+ </fuselage_accommodation>
+ </fuselage>
+ </geometry>
+ </specific>
+ </fuselage>
+ <tank description="Description of aircraft tanks." tool_level="0">
+ <position description="Position of the tanks with regard to the global reference point.">
+ <x_position description="Distance between the foremost tank end and the global reference point in x-direction.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>80</upper_boundary>
+ </x_position>
+ <y_position description="Distance between the foremost tank end and the global reference point in y-direction.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-40</lower_boundary>
+ <upper_boundary>40</upper_boundary>
+ </y_position>
+ <z_position description="Distance between the foremost tank end and the global reference point in z-direction.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </position>
+ <mass_properties description="Mass properties of all tanks.">
+ <mass description="Total tank mass.">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100000</upper_boundary>
+ </mass>
+ <inertia description="Inertia of all tanks with regard to the total center of gravity.">
+ <j_xx description="Inertia of all tanks in x.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="Inertia of all tanks in y.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="Inertia of all tanks in z.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="Inertia of all tanks in xy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="Inertia of all tanks in xz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="Inertia of all tanks in yx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="Inertia of all tanks in yz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="Inertia of all tanks in zx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="Inertia of all tanks in zy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="Center of gravity of all tanks.">
+ <x_position description="Center of gravity in x-direction with regard to the global reference point.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>80</upper_boundary>
+ </x_position>
+ <y_position description="Center of gravity in y-direction with regard to the global reference point.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-40</lower_boundary>
+ <upper_boundary>40</upper_boundary>
+ </y_position>
+ <z_position description="Center of gravity in z-direction with regard to the global reference point.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </center_of_gravity>
+ </mass_properties>
+ <specific>
+ <tank ID="0" description="Description of one tank.">
+ <name description="Designator of the tank (right/left hand inner/outer wing tank, centre tank, trim tank, cylindrical/conical tail cone tank, ...).">
+ <value>right hand inner wing tank</value>
+ </name>
+ <position description="Position of one tank with regard to the global reference point.">
+ <x_position description="Distance between the foremost tank end of one tank and the global reference point in x-direction.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>80</upper_boundary>
+ </x_position>
+ <y_position description="Distance between the foremost tank end of one tank and the global reference point in y-direction.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-40</lower_boundary>
+ <upper_boundary>40</upper_boundary>
+ </y_position>
+ <z_position description="Distance between the foremost tank end of one tank and the global reference point in z-direction.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </position>
+ <mass_properties description="Mass properties of one tank.">
+ <mass description="Total dry mass of one tank.">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100000</upper_boundary>
+ </mass>
+ <inertia description="Inertia of one tank with regard to its center of gravity.">
+ <j_xx description="Inertia of one tank in x.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="Inertia of one tank in y.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="Inertia of one tank in z.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="Inertia of one tank in xy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="Inertia of one tank in xz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="Inertia of one tank in yx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="Inertia of one tank in yz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="Inertia of one tank in zx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="Inertia of one tank in zy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="Center of gravity of one tank.">
+ <x_position description="Center of gravity in x-direction with regard to the global reference point.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>80</upper_boundary>
+ </x_position>
+ <y_position description="Center of gravity in y-direction with regard to the global reference point.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-40</lower_boundary>
+ <upper_boundary>40</upper_boundary>
+ </y_position>
+ <z_position description="Center of gravity in z-direction with regard to the global reference point.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </center_of_gravity>
+ </mass_properties>
+ <volume description="Total usable volume of one tank.">
+ <value>0</value>
+ <unit>l</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100000</upper_boundary>
+ </volume>
+ <geometry description="Geometrical description of one tank.">
+ <cross_section ID="0" description="Geometrical description of one tank cross section.">
+ <name description="Designator of tank cross section.">
+ <value>first cross section</value>
+ </name>
+ <position description="Position of tank cross section with regard to the global reference point.">
+ <x_position description="Distance between the tank cross section and the global reference point in x-direction.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>80</upper_boundary>
+ </x_position>
+ <y_position description="Distance between the tank cross section and the global reference point in y-direction.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-40</lower_boundary>
+ <upper_boundary>40</upper_boundary>
+ </y_position>
+ <z_position description="Distance between the tank cross section and the global reference point in z-direction.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-5</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </z_position>
+ </position>
+ <shape description="Description of the shape of the cross section (circular, rectangular, elliptical).">
+ <value>rectangular</value>
+ </shape>
+ <height description="Height of the cross section.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </height>
+ <width description="Width of the cross section.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </width>
+ <length description="Length of the cross section (if length > 0: curved cross section, e.g., dashed tank endcap).">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </length>
+ </cross_section>
+ </geometry>
+ </tank>
+ </specific>
+ </tank>
+ <empennage description="empennage component" tool_level="0">
+ <position description="position of empennage (most forward position of part composition)">
+ <x description="x position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </position>
+ <mass_properties description="mass_properties of component empennage">
+ <mass description="component mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="component inertia refered to center of gravity">
+ <j_xx description="inertia component in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia component in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia component in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia component in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia component in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia component in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia component in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia component in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia component in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="component center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ <specific>
+ <geometry>
+ <aerodynamic_surface description="aerodynamic surface" ID="0">
+ <name description="name of aerodynamic surface">
+ <value>fin</value>
+ </name>
+ <position description="reference position in global coordinates">
+ <x description="x position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </position>
+ <parameters description="aerodynamic surface parameters">
+ <direction description="unit vector according to global coordinate system for direction applied at position">
+ <x description="x direction of unit vector">
+ <value>0.0</value>
+ <unit>1</unit>
+ <lower_boundary>-1.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </x>
+ <y description="y direction of unit vector">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>-1.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </y>
+ <z description="z direction of unit vector">
+ <value>0.0</value>
+ <unit>1</unit>
+ <lower_boundary>-1.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </z>
+ </direction>
+ <symmetric description="symmetric to x-z plane (global) aerodynamic surface">
+ <value>true</value>
+ </symmetric>
+ <sections description="sections">
+ <section description="section" ID="0">
+ <chord_origin description="origin of chord (local)">
+ <x description="x position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z position">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </chord_origin>
+ <chord_length description="length of chord">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </chord_length>
+ <geometric_twist description="geometric twist at leading edge">
+ <value>0.0</value>
+ <unit>rad</unit>
+ <lower_boundary>-</lower_boundary>
+ <upper_boundary />
+ </geometric_twist>
+ <profile description="profile (data normalized on chord)">
+ <name>
+ <value>naca0012</value>
+ </name>
+ </profile>
+ </section>
+ </sections>
+ <spars description="spars">
+ <spar description="front spar" ID="0">
+ <position description="chord relative position of control device">
+ <inner_position description="relative inner position">
+ <spanwise description="relative spanwise position">
+ <value>0.</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </inner_position>
+ <outer_position description="relative outer position">
+ <spanwise description="relative spanwise position">
+ <value>0.2</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </outer_position>
+ </position>
+ </spar>
+ <spar description="rear spar" ID="1">
+ <position description="chord relative position of control device">
+ <inner_position description="relative inner position">
+ <spanwise description="relative spanwise position">
+ <value>0.</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </inner_position>
+ <outer_position description="relative outer position">
+ <spanwise description="relative spanwise position">
+ <value>0.2</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </outer_position>
+ </position>
+ </spar>
+ </spars>
+ <control_devices description="control devices">
+ <control_device description="control device" ID="0">
+ <type>
+ <value>aileron</value>
+ </type>
+ <deflection description="maximum positive and negative deflection of control device">
+ <full_negative_deflection description="full negative deflection">
+ <value>-25.0</value>
+ <unit>deg</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </full_negative_deflection>
+ <full_positive_deflection description="full positive deflection">
+ <value>25.0</value>
+ <unit>deg</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </full_positive_deflection>
+ </deflection>
+ <position description="chord relative position of control device">
+ <inner_position description="relative inner position">
+ <spanwise description="relative spanwise position">
+ <value>0.2</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </inner_position>
+ <outer_position description="relative outer position">
+ <spanwise description="relative spanwise position">
+ <value>0.2</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </spanwise>
+ <chord description="control device chord position">
+ <from description="relative chord position">
+ <value>0.7</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </from>
+ <to description="relative chord position">
+ <value>1.0</value>
+ <unit>1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </to>
+ </chord>
+ </outer_position>
+ </position>
+ </control_device>
+ </control_devices>
+ </parameters>
+ <mass_properties description="mass_properties of aerodynamic surface">
+ <mass description="component mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="component inertia refered to center of gravity">
+ <j_xx description="inertia component in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia component in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia component in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia component in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia component in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia component in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia component in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia component in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia component in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="component center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </aerodynamic_surface>
+ </geometry>
+ </specific>
+ </empennage>
+ <landing_gear description="Geometric description of the aircraft undercarriage." tool_level="0">
+ <position description="Position of the total undercarriage arrangment with regard to the global reference point.">
+ <x_position description="Distance in x direction with regard to the global reference point. (total undercarriage arrangment)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>50</upper_boundary>
+ </x_position>
+ <y_position description="Distance in y direction with regard to the global reference point. (total undercarriage arrangment)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </y_position>
+ <z_position description="Distance in z direction with regard to the global reference point. (total undercarriage arrangment)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </z_position>
+ </position>
+ <mass_properties description="Mass properties of the total undercarriage arrangment.">
+ <mass description="Mass of the total undercarriage arrangment.">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="Inertia of the total undercarriage arrangment with regard to the total center of gravity.">
+ <j_xx description="Inertia of the total undercarriage arrangment in x.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="Inertia of the total undercarriage arrangment in y.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="Inertia of the total undercarriage arrangment in z.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="Inertia of the total undercarriage arrangment in xy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="Inertia of the total undercarriage arrangment in xz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="Inertia of the total undercarriage arrangment in yx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="Inertia of the total undercarriage arrangment in yz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="Inertia of the total undercarriage arrangment in zx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="Inertia of the total undercarriage arrangment in zy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="Center of gravity of the total undercarriage arrangment.">
+ <x_position description="Center of gravity in x-direction with regard to the global reference point. (total undercarriage arrangment)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>50</upper_boundary>
+ </x_position>
+ <y_position description="Center of gravity in y-direction with regard to the global reference point. (total undercarriage arrangment)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </y_position>
+ <z_position description="Center of gravity in z-direction with regard to the global reference point. (total undercarriage arrangment)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </z_position>
+ </center_of_gravity>
+ </mass_properties>
+ <specific>
+ <aircraft_classification_number description="Aircraft classification number for the total undercarriage arrangment.">
+ <value>return_string</value>
+ </aircraft_classification_number>
+ <aircraft_classification_rating description="Aircraft classification rating for the total undercarriage arrangment.">
+ <value>return_string</value>
+ </aircraft_classification_rating>
+ <geometry>
+ <number_of_landing_gear_struts description="Number of installed landing gear struts.">
+ <value>0</value>
+ <unit>1</unit>
+ <lower_boundary>3</lower_boundary>
+ <upper_boundary>6</upper_boundary>
+ </number_of_landing_gear_struts>
+ <landing_gear_leg ID="0" description="Geometrical description of one entire landing gear leg.">
+ <name description="Name of the landing gear leg.">
+ <value>nose_gear</value>
+ </name>
+ <position description="Position of one entire landing gear leg with regard to the global reference point.">
+ <x_position description="Distance in x direction with regard to the global reference point. (center line of the landing gear leg)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100</upper_boundary>
+ </x_position>
+ <y_position description="Distance in y direction with regard to the global reference point. (center line of the landing gear leg)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-15</lower_boundary>
+ <upper_boundary>15</upper_boundary>
+ </y_position>
+ <z_position description="Distance in z direction with regard to the global reference point. (z coordinate refers to the mounting point of the landing gear leg.)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </z_position>
+ </position>
+ <mass_properties description="Mass properties of one entire landing gear leg.">
+ <mass description="Mass of one entire landing gear leg.">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10000</upper_boundary>
+ </mass>
+ <inertia description="Inertia of one entire landing gear leg with regard to his center of gravity.">
+ <j_xx description="Inertia of one entire landing gear leg in x.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="Inertia of one entire landing gear leg in y.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="Inertia of one entire landing gear leg in z.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="Inertia of one entire landing gear leg xy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="Inertia of one entire landing gear leg in xz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="Inertia of one entire landing gear leg in yx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="Inertia of one entire landing gear leg in yz.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="Inertia of one entire landing gear leg in zx.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="Inertia of one entire landing gear leg in zy.">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="Center of gravity of one entire landing gear leg.">
+ <x_position description="Center of gravity in x-direction with regard to the global reference point. (entire landing gear leg)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>50</upper_boundary>
+ </x_position>
+ <y_position description="Center of gravity in y-direction with regard to the global reference point. (entire landing gear leg)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </y_position>
+ <z_position description="Center of gravity in z-direction with regard to the global reference point. (entire landing gear leg)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </z_position>
+ </center_of_gravity>
+ </mass_properties>
+ <assambly_components>
+ <strut_diameter Desc="Diameter of the landing gear strut.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </strut_diameter>
+ <strut_length Desc="Length of the landing gear strut.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </strut_length>
+ <wheel_group_position Desc="Position of wheel group of one entire landing gear leg.">
+ <x_position description="Distance in x direction with regard to the global reference point (center line of the landing gear leg)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100</upper_boundary>
+ </x_position>
+ <y_position description="Distance in y direction with regard to the global reference point (center line of the landing gear leg)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-15</lower_boundary>
+ <upper_boundary>15</upper_boundary>
+ </y_position>
+ <z_position description="Distance in z direction with regard to the global reference point (z coordinate refers to the end point of the landing gear leg.)">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-20</lower_boundary>
+ <upper_boundary>0</upper_boundary>
+ </z_position>
+ </wheel_group_position>
+ <number_of_axis_of_wheel_group Desc="Number of axis of the wheel group behind each other.">
+ <value>0</value>
+ <unit>1</unit>
+ <lower_boundary>1</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </number_of_axis_of_wheel_group>
+ <wheel_base Desc="Distance of the foremost to the rearmost axis of the wheel group.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>15</upper_boundary>
+ </wheel_base>
+ <wheel_track Desc="Distance between the outermost wheels of an axis.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>5</upper_boundary>
+ </wheel_track>
+ <number_of_tires_per_axis Desc="Number of tires per axis of a tire group.">
+ <value>0</value>
+ <unit>1</unit>
+ <lower_boundary>1</lower_boundary>
+ <upper_boundary>4</upper_boundary>
+ </number_of_tires_per_axis>
+ <tire_description Desc="Description of one tire of the wheel group">
+ <tire_diameter Desc="Diameter of the wheel group tires.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>2</upper_boundary>
+ </tire_diameter>
+ <tire_width Desc="Width of the wheel group tires.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </tire_width>
+ <rim_diameter Desc="Rim diameter of the wheel group tires.">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </rim_diameter>
+ <tire_pressure Desc="Tire pressure of the wheel group tires.">
+ <value>0</value>
+ <unit>Pa</unit>
+ <lower_boundary>1000000</lower_boundary>
+ <upper_boundary>2000000</upper_boundary>
+ </tire_pressure>
+ <maximum_tire_speed Desc="Maximum permissible tire speed of the wheel group tires.">
+ <value>0</value>
+ <unit>m/s</unit>
+ <lower_boundary>50</lower_boundary>
+ <upper_boundary>125</upper_boundary>
+ </maximum_tire_speed>
+ </tire_description>
+ </assambly_components>
+ </landing_gear_leg>
+ </geometry>
+ </specific>
+ </landing_gear>
+ <propulsion description="Propulsion components" ID="0" tool_level="0">
+ <position description="Reference positions of the propulsion assembly">
+ <nacelle description="Position of nacelle element in aircraft coordinate system (center of inlet)">
+ <x description="x direction of nacelle">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>100</upper_boundary>
+ </x>
+ <y description="y direction of nacelle">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>-50</lower_boundary>
+ <upper_boundary>50</upper_boundary>
+ </y>
+ <z description="z direction of nacelle">
+ <unit>m</unit>
+ <value>0</value>
+ <lower_boundary>-20</lower_boundary>
+ <upper_boundary>40</upper_boundary>
+ </z>
+ </nacelle>
+ </position>
+ <mass_properties description="Mass properties of propulsion assembly">
+ <nacelle>
+ <mass description="nacelle mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10000</upper_boundary>
+ </mass>
+ <inertia description="nacelle inertia refered to its center of gravity">
+ <j_xx description="inertia component in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia component in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia component in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia component in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia component in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia component in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia component in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia component in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia component in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="nacelle center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </nacelle>
+ <pylon>
+ <mass description="component mass pylon">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10000</upper_boundary>
+ </mass>
+ <inertia description="component inertia refered to center of gravity">
+ <j_xx description="inertia component in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia component in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia component in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia component in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia component in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia component in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia component in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia component in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia component in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="component center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </pylon>
+ <engine>
+ <mass description="component mass engine">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10000</upper_boundary>
+ </mass>
+ <inertia description="component inertia refered to center of gravity">
+ <j_xx description="inertia component in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia component in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia component in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia component in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia component in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia component in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia component in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia component in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia component in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="component center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </engine>
+ </mass_properties>
+ <specific description="Specific nacelle and engine properties">
+ <nacelle description="Parametric description of nacelle geometry">
+ <incidence_angle description="Angle of incidence in reference to the aircrafts coordinate system">
+ <unit>degree</unit>
+ <lower_boundary>-10</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </incidence_angle>
+ <number_points description="No of points describing the section">
+ <value>0</value>
+ </number_points>
+ <number_segments description="Number of segments describing the nacelle">
+ <value>0</value>
+ </number_segments>
+ <inlet_segment description="Geometric desciption of the nacelle inlet segment">
+ <segment_point_data>
+ <value>0</value>
+ </segment_point_data>
+ <width_inlet description="Width of the nacelle segment">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </width_inlet>
+ <height_inlet description="Height of the nacelle segment">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </height_inlet>
+ <length_inlet description="Length of the nacelle segment">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </length_inlet>
+ </inlet_segment>
+ <nacelle_segment ID="0">
+ <inner_segment_point_data>
+ <value>0</value>
+ </inner_segment_point_data>
+ <outer_segment_point_data>
+ <value>0</value>
+ </outer_segment_point_data>
+ <width_inner_segment description="Inner widht of nacelle segment">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </width_inner_segment>
+ <width_outer_segment description="Outer widht of nacelle segment">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </width_outer_segment>
+ <height_inner_segment description="Inner height of nacelle segment">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </height_inner_segment>
+ <height_outer_segment description="Outer height of nacelle segment">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </height_outer_segment>
+ <length_segment description="length of the nacelle segment">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </length_segment>
+ </nacelle_segment>
+ <exit_segment description="Geometric desciption of the nacelle exit segment">
+ <segment_point_data>
+ <value>0</value>
+ </segment_point_data>
+ <width_inlet description="Width of the nacelle exit segment">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </width_inlet>
+ <height_inlet description="height of the nacelle exit segment">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>10</upper_boundary>
+ </height_inlet>
+ </exit_segment>
+ </nacelle>
+ <engine description="Parametric description of engine settings, geometry and performance">
+ <settings description="Settings of engine model and improvment factor (from config)">
+ <engine_model description="Name of selected engine model">
+ <value>0.0</value>
+ </engine_model>
+ <fuel_flow_scale_factor description="Selected fuel flow scaling/improvement factor">
+ <value>0.0</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </fuel_flow_scale_factor>
+ <maximum_shaft_power_extraction description="Maximum shaft power extraction of the engine for aircraft onboard systems">
+ <value>0.0</value>
+ <unit>W</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>3E+5</upper_boundary>
+ </maximum_shaft_power_extraction>
+ </settings>
+ <turboprop_propeller_diameter description="Diameter of the propeller of the turboprop">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>1.75</lower_boundary>
+ <lower_boundary>5.3</lower_boundary>
+ </turboprop_propeller_diameter>
+ <performance description="Performance specific parameter">
+ <scale_factor description="Performance scaling factor">
+ <value>0.0</value>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>1.0</upper_boundary>
+ </scale_factor>
+ <maximum_take_off description="Performance at maximum take off condition at ISA+deltaISA (Requirements/DesignMission) with no offtakes at Mach=0.0 and altitude=0.0">
+ <thrust>
+ <value>0.0</value>
+ <unit>N</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>999.0</upper_boundary>
+ </thrust>
+ </maximum_take_off>
+ <maximum_continuous description="Performance at maximum continuous conditions at ISA+deltaISA (Requirements/DesignMission) with no offtakes at predefined Mach and altitude">
+ <maximum_thrust description="Performance at maximum thrust at maximum continuous conditions">
+ <thrust>
+ <value>0.0</value>
+ <unit>N</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>999.0</upper_boundary>
+ </thrust>
+ <thrust_specific_fuel_consumption>
+ <value>0.0</value>
+ <unit>kgs^-1N^-1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>999.0</upper_boundary>
+ </thrust_specific_fuel_consumption>
+ </maximum_thrust>
+ <bucket_thrust description="performance at bucket thrust at maximum continuous conditions">
+ <thrust>
+ <value>0.0</value>
+ <unit>N</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>999.0</upper_boundary>
+ </thrust>
+ <thrust_specific_fuel_consumption>
+ <value>0.0</value>
+ <unit>kgs^-1N^-1</unit>
+ <lower_boundary>0.0</lower_boundary>
+ <upper_boundary>999.0</upper_boundary>
+ </thrust_specific_fuel_consumption>
+ </bucket_thrust>
+ </maximum_continuous>
+ </performance>
+ </engine>
+ </specific>
+ </propulsion>
+ <systems tool_level="0">
+ <position />
+ <mass_properties description="mass_properties of component systems">
+ <mass description="component mass">
+ <systems_group description="total systems group">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </systems_group>
+ <auxiliary_power_unit description="Airbus Chapter 30, ATA49">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </auxiliary_power_unit>
+ <hydraulic_generation description="Airbus Chapter 31, ATA 29">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </hydraulic_generation>
+ <hydraulic_distribution description="Airbus Chapter 32, ATA 29">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </hydraulic_distribution>
+ <air_conditioning description="Airbus Chapter 33, ATA21">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </air_conditioning>
+ <de_icing description="Airbus Chapter 34, ATA30">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </de_icing>
+ <fire_protection description="Airbus Chapter 35, ATA26">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </fire_protection>
+ <flight_controls description="Airbus Chapter 36, ATA27">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ <roll description="aileron actuators, their installations and operation controls, Airbus Ch. 36.0">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </roll>
+ <yaw description="rudder actuators, their installations and operation controls, Airbus Ch. 36.1">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </yaw>
+ <pitch description="elevator actuators, their installations and operation controls, Airbus Ch. 36.2">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </pitch>
+ <movable_horizontal_tail description="movable horizontal tail actuators, their installations and operation controls, Airbus Ch. 36.3">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </movable_horizontal_tail>
+ <flaps description="flap actuators, their installations and operation controls, Airbus Ch. 36.4">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </flaps>
+ <spoilers_airbrakes_liftdumpers description="spoiler actuators, their installations and operation controls, Airbus Ch. 36.5">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </spoilers_airbrakes_liftdumpers>
+ <slats description="Mass of the slat actuators, their installations and operation controls, Airbus Ch. 36.6">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </slats>
+ <common_installation description="flight control common installation, Airbus Ch. 36.7">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </common_installation>
+ </flight_controls>
+ <instruments description="Airbus Chapter 37, ATA31">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </instruments>
+ <automatic_flight_system description="Airbus Chapter 38, ATA 22">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </automatic_flight_system>
+ <navigation description="Airbus Chapter 39, ATA34">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </navigation>
+ <communication description="Airbus Chapter 40, ATA23">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </communication>
+ <electrical_generation description="Airbus Chapter 41, ATA24, generation">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </electrical_generation>
+ <electrical_distribution description="Airbus Chapter 42, ATA24, distribution">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </electrical_distribution>
+ </mass>
+ <inertia />
+ <center_of_gravity description="component center of gravity with respect to global coordinate system">
+ <systems_group description="total systems group">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </systems_group>
+ <auxiliary_power_unit description="Airbus Chapter 30, ATA49">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </auxiliary_power_unit>
+ <hydraulic_generation description="Airbus Chapter 31, ATA 29">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </hydraulic_generation>
+ <hydraulic_distribution description="Airbus Chapter 32, ATA 29">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </hydraulic_distribution>
+ <air_conditioning description="Airbus Chapter 33, ATA21">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </air_conditioning>
+ <de_icing description="Airbus Chapter 34, ATA30">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </de_icing>
+ <fire_protection description="Airbus Chapter 35, ATA26">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </fire_protection>
+ <flight_controls description="Airbus Chapter 36, ATA27">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ <roll description="aileron actuators, their installations and operation controls, Airbus Ch. 36.0">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </roll>
+ <yaw description="rudder actuators, their installations and operation controls, Airbus Ch. 36.1">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </yaw>
+ <pitch description="elevator actuators, their installations and operation controls, Airbus Ch. 36.2">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </pitch>
+ <movable_horizontal_tail description="movable horizontal tail actuators, their installations and operation controls, Airbus Ch. 36.3">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </movable_horizontal_tail>
+ <flaps description="flap actuators, their installations and operation controls, Airbus Ch. 36.4">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </flaps>
+ <spoilers_airbrakes_liftdumpers description="spoiler actuators, their installations and operation controls, Airbus Ch. 36.5">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </spoilers_airbrakes_liftdumpers>
+ <slats description="Mass of the slat actuators, their installations and operation controls, Airbus Ch. 36.6">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </slats>
+ <common_installation description="flight control common installation, Airbus Ch. 36.7">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </common_installation>
+ </flight_controls>
+ <instruments description="Airbus Chapter 37, ATA31">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </instruments>
+ <automatic_flight_system description="Airbus Chapter 38, ATA 22">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </automatic_flight_system>
+ <navigation description="Airbus Chapter 39, ATA34">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </navigation>
+ <communication description="Airbus Chapter 40, ATA23">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </communication>
+ <electrical_generation description="Airbus Chapter 41, ATA24, generation">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </electrical_generation>
+ <electrical_distribution description="Airbus Chapter 42, ATA24, distribution">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <lower_boundary>inf</lower_boundary>
+ </z>
+ </electrical_distribution>
+ </center_of_gravity>
+ </mass_properties>
+ <specific>
+ <design_power description="design power of ATA29, ATA49, ATA70">
+ <ATA29_hydraulic_system>
+ <design_power description="maximum design power">
+ <electric description="maximum demand for electrical power">
+ <value>0</value>
+ <unit>W</unit>
+ </electric>
+ <hydraulic description="maximum demand for hydraulic power">
+ <value>0</value>
+ <unit>W</unit>
+ </hydraulic>
+ <bleed_air description="maximum demand for bleed air">
+ <value>0</value>
+ <unit>kg/s</unit>
+ </bleed_air>
+ </design_power>
+ <pressure description="nominal pressure of hydraulic system">
+ <value>0</value>
+ <unit>Pa</unit>
+ </pressure>
+ </ATA29_hydraulic_system>
+ <ATA49_auxiliary_power_unit>
+ <design_power description="maximum design power">
+ <electric description="maximum demand for electrical power">
+ <value>0</value>
+ <unit>W</unit>
+ </electric>
+ <hydraulic description="maximum demand for hydraulic power">
+ <value>0</value>
+ <unit>W</unit>
+ </hydraulic>
+ <bleed_air description="maximum demand for bleed air">
+ <value>0</value>
+ <unit>kg/s</unit>
+ </bleed_air>
+ </design_power>
+ </ATA49_auxiliary_power_unit>
+ <ATA70_propulsion_system>
+ <design_power description="maximum design power">
+ <electric description="maximum demand for electrical power">
+ <value>0</value>
+ <unit>W</unit>
+ </electric>
+ <hydraulic description="maximum demand for hydraulic power">
+ <value>0</value>
+ <unit>W</unit>
+ </hydraulic>
+ <bleed_air description="maximum demand for bleed air">
+ <value>0</value>
+ <unit>kg/s</unit>
+ </bleed_air>
+ </design_power>
+ </ATA70_propulsion_system>
+ </design_power>
+ <offtakes description="total shaft power and bleed air offtakes from sink systems">
+ <design_mission>
+ <average_cruise_offtakes description="average offtakes during cruise and changeFL for the design mission">
+ <shaft_power_total description="total shaft offtakes from all sink systems">
+ <value>0</value>
+ <unit>W</unit>
+ </shaft_power_total>
+ <bleed_air_total description="total bleed air offtake from all sink systems">
+ <value>0</value>
+ <unit>kg/s</unit>
+ </bleed_air_total>
+ </average_cruise_offtakes>
+ </design_mission>
+ <study_mission>
+ <average_cruise_offtakes description="average offtakes during cruise and changeFL for the study mission">
+ <shaft_power_total description="total shaft offtakes from all sink systems">
+ <value>0</value>
+ <unit>W</unit>
+ </shaft_power_total>
+ <bleed_air_total description="total bleed air offtake from all sink systems">
+ <value>0</value>
+ <unit>kg/s</unit>
+ </bleed_air_total>
+ </average_cruise_offtakes>
+ </study_mission>
+ </offtakes>
+ </specific>
+ </systems>
+ </component_design>
+ <analysis>
+ <masses_cg_inertia description="masses, cgs, inertias." tool_level="0">
+ <manufacturer_mass_empty description="MME">
+ <mass_properties description="manufacturer mass empty properties">
+ <mass description="mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </manufacturer_mass_empty>
+ <operating_mass_empty description="OME">
+ <mass_properties description="operating mass empty properties">
+ <mass description="mass">
+ <value>42307.66255</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </operating_mass_empty>
+ <maximum_zero_fuel_mass description="MZFM">
+ <mass_properties description="maximum zero fuel mass properties">
+ <mass description="mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </maximum_zero_fuel_mass>
+ <maximum_landing_mass description="MLM">
+ <mass_properties description="maximum landing mass properties">
+ <mass description="mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </maximum_landing_mass>
+ <maximum_takeoff_mass description="MTOM">
+ <mass_properties description="maximum landing mass properties">
+ <mass description="mass">
+ <value>79144.73202</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </maximum_takeoff_mass>
+ <maximum_payload_mass description="maximum payload mass">
+ <mass_properties description="maximum payload mass properties">
+ <mass description="mass">
+ <value>20000</value>
+ <unit>kg</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </maximum_payload_mass>
+ <maximum_fuel_mass description="maximum fuel mass">
+ <mass_properties description="maximum fuel mass properties">
+ <mass description="mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </maximum_fuel_mass>
+ <most_forward_mass description="mass for most forward cg position">
+ <mass_properties description="maximum fuel mass properties">
+ <mass description="mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </most_forward_mass>
+ <most_aft_mass description="mass for most aft cg position">
+ <mass_properties description="most aft mass properties">
+ <mass description="mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </most_aft_mass>
+ <design_mass description="design mass ">
+ <mass_properties description="design mass properties">
+ <mass description="mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </design_mass>
+ <most_afterward_mass description="mass for most afterward cg position">
+ <mass_properties description="most afterward mass properties">
+ <mass description="mass">
+ <value>0.0</value>
+ <unit>kg</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mass>
+ <inertia description="inertia refered to center of gravity">
+ <j_xx description="inertia in x">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xx>
+ <j_yy description="inertia in y">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yy>
+ <j_zz description="inertia in z">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zz>
+ <j_xy description="inertia in xy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xy>
+ <j_xz description="inertia in xz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_xz>
+ <j_yx description="inertia in yx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yx>
+ <j_yz description="inertia in yz">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_yz>
+ <j_zx description="inertia in zx">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zx>
+ <j_zy description="inertia in zy">
+ <value>0.0</value>
+ <unit>kgm^2</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </j_zy>
+ </inertia>
+ <center_of_gravity description="center of gravity with respect to global coordinate system">
+ <x description="x component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </x>
+ <y description="y component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </y>
+ <z description="z component">
+ <value>0.0</value>
+ <unit>m</unit>
+ <lower_boundary>-inf</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </z>
+ </center_of_gravity>
+ </mass_properties>
+ </most_afterward_mass>
+ </masses_cg_inertia>
+ <aerodynamics description="Aerodynamcal analysis." level="0">
+ <reference_values>
+ <b description="Total wing span" tool_level="0">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>80</upper_boundary>
+ </b>
+ <MAC description="Mean aerodynamic chord" tool_level="0">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>50</upper_boundary>
+ </MAC>
+ <S_ref description="Wing reference area" tool_level="0">
+ <value>0</value>
+ <unit>m^2</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </S_ref>
+ </reference_values>
+ <lift_coefficients>
+ <C_LmaxLanding description="Maximum lift coefficient in landing configuration" tool_level="0">
+ <value>0</value>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </C_LmaxLanding>
+ <C_LmaxT-O description="Maximum lift coefficient in take off configuration" tool_level="0">
+ <value>0</value>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </C_LmaxT-O>
+ <C_LoptimumCruise description="Lift coefficient at L/D_optimum at M_initial_cruise" tool_level="0">
+ <value>0</value>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </C_LoptimumCruise>
+ <C_LgroundRoll description="Lift coefficient on ground for ground roll calculation" tool_level="0">
+ <value>0</value>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </C_LgroundRoll>
+ </lift_coefficients>
+ <polar>
+ <polar_file description="Name of polar file" tool_level="0">
+ <value>0</value>
+ </polar_file>
+ <configurations description="Number of configurations in the polar file" tool_level="0">
+ <value>0</value>
+ </configurations>
+ <configuration description="Configuration in polar file marked with ID - name can vary" ID="1" tool_level="0">
+ <type>Cruise</type>
+ <value>0</value>
+ </configuration>
+ <configuration description="Configuration in polar file marked with ID - name can vary" ID="2" tool_level="0">
+ <type>Departure</type>
+ <value>0</value>
+ </configuration>
+ <configuration description="Configuration in polar file marked with ID - name can vary" ID="3" tool_level="0">
+ <type>Departure</type>
+ <value>0</value>
+ </configuration>
+ <configuration description="Configuration in polar file marked with ID - name can vary" ID="4" tool_level="0">
+ <type>Departure</type>
+ <value>0</value>
+ </configuration>
+ <configuration description="Configuration in polar file marked with ID - name can vary" ID="5" tool_level="0">
+ <type>Approach</type>
+ <value>0</value>
+ </configuration>
+ <configuration description="Configuration in polar file marked with ID - name can vary" ID="6" tool_level="0">
+ <type>Approach</type>
+ <value>0</value>
+ </configuration>
+ <configuration description="Configuration in polar file marked with ID - name can vary" ID="7" tool_level="0">
+ <type>Approach</type>
+ <value>0</value>
+ </configuration>
+ </polar>
+ <max_spoiler_factor description="Factor for maximum drag increase trough spoilers" tool_level="0">
+ <value>0</value>
+ <lower_boundary>1</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </max_spoiler_factor>
+ </aerodynamics>
+ <mission description="Mission data." tool_level="0">
+ <design_mission description="Data of design mission">
+ <range description="Range of design mission">
+ <value>2500.496279</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>3000000</upper_boundary>
+ </range>
+ <block_time description="Block time of design mission: Time from break release to end of taxiing after landing">
+ <value>0</value>
+ <unit>s</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>126000</upper_boundary>
+ </block_time>
+ <flight_time description="Flight time of design mission">
+ <value>0</value>
+ <unit>s</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>12600</upper_boundary>
+ </flight_time>
+ <taxi_fuel_take_off description="Taxi fuel before takeoff in design mission">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </taxi_fuel_take_off>
+ <taxi_fuel_landing description="Taxi fuel after landing in design mission">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1000</upper_boundary>
+ </taxi_fuel_landing>
+ <mission_fuel description="Total fuel loaded for design mission">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mission_fuel>
+ <trip_fuel description="Fuel burned from takeoff to landing">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </trip_fuel>
+ <payload description="Payload of design mission">
+ <value>17000</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </payload>
+ <number_of_pax description="Number of passengers of design mission">
+ <value>0</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </number_of_pax>
+ <cargo_mass description="Cargo mass of design mission">
+ <value>3392</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </cargo_mass>
+ <take_off_engine_derate Desc="Engine power demand">
+ <value>0</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </take_off_engine_derate>
+ <cruise_steps description="Cruise step information">
+ <numer_of_cruise_steps description="Number of cruise steps in design mission">
+ <value>0</value>
+ <unit>-</unit>
+ </numer_of_cruise_steps>
+ <cruise_step description="Data of cruise step" ID="0">
+ <relative_end_of_cruise_step description="End of cruise step relative to mission length">
+ <value>0</value>
+ <unit>-</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </relative_end_of_cruise_step>
+ <altitude description="Altitude of cruise step">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>15000</upper_boundary>
+ </altitude>
+ </cruise_step>
+ </cruise_steps>
+ <take_off_mass description="Take off mass">
+ <value>79144.73202</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </take_off_mass>
+ </design_mission>
+ <study_mission description="Data of study mission">
+ <range description="Range of study mission">
+ <value>500.6435584</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>3000000</upper_boundary>
+ </range>
+ <block_time description="Block time of study mission: Time from break release to end of taxiing after landing">
+ <value>0</value>
+ <unit>s</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>126000</upper_boundary>
+ </block_time>
+ <flight_time description="Flight time of study mission">
+ <value>0</value>
+ <unit>s</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>12600</upper_boundary>
+ </flight_time>
+ <taxi_fuel_takeoff description="Taxi fuel before takeoff in study mission">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>500</upper_boundary>
+ </taxi_fuel_takeoff>
+ <taxi_fuel_landing description="Taxi fuel after landing in study mission">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>500</upper_boundary>
+ </taxi_fuel_landing>
+ <mission_fuel description="Total fuel loaded for study mission">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </mission_fuel>
+ <trip_fuel description="Fuel burned from takeoff to landing">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </trip_fuel>
+ <payload description="Payload of study mission">
+ <value>13608</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </payload>
+ <cruise_steps description="Cruise step information">
+ <numer_of_cruise_steps description="Number of cruise steps in study mission">
+ <value>0</value>
+ <unit>-</unit>
+ </numer_of_cruise_steps>
+ <cruise_step description="Data of cruise step" ID="0">
+ <relative_end_of_cruise_step description="End of cruise step relative to mission length">
+ <value>0</value>
+ <unit>-</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </relative_end_of_cruise_step>
+ <altitude description="Altitude of cruise step">
+ <value>0</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>15000</upper_boundary>
+ </altitude>
+ </cruise_step>
+ </cruise_steps>
+ <payload description="Payload of study mission">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </payload>
+ <number_of_pax description="Number of passengers of study mission">
+ <value>0</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </number_of_pax>
+ <cargo_mass description="Cargo mass of study mission">
+ <value>0</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </cargo_mass>
+ <take_off_engine_derate Desc="Engine power demand">
+ <value>0</value>
+ <unit>1</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1</upper_boundary>
+ </take_off_engine_derate>
+ </study_mission>
+ </mission>
+ <requirement_compliance>
+ <top_level_aircraft_requirements tool_level="0">
+ <design_take_off_field_length description="Switch indicating if take off field length can be maintained.">
+ <value>0</value>
+ <unit>-</unit>
+ <checked description="Indicates if the value has been checked against the requirement.">
+ <value>0</value>
+ <unit>-</unit>
+ </checked>
+ </design_take_off_field_length>
+ <design_landing_field_length description="Switch indicating if landing fiel length can be maintained.">
+ <value>0</value>
+ <unit>-</unit>
+ <checked description="Indicates if the value has been checked against the requirement.">
+ <value>0</value>
+ <unit>-</unit>
+ </checked>
+ </design_landing_field_length>
+ <design_approach_speed description="Switch indicating if approach speed can be maintained.">
+ <value>0</value>
+ <unit>-</unit>
+ <checked description="Indicates if the value has been checked against the requirement.">
+ <value>0</value>
+ <unit>-</unit>
+ </checked>
+ </design_approach_speed>
+ </top_level_aircraft_requirements>
+ <certification tool_level="0">
+ <climb_gradient_of_second_take_off_segment description="Switch if landing field length can be maintained">
+ <value>0</value>
+ <unit>-</unit>
+ <checked description="Indicates if the value has been checked against the requirement.">
+ <value>0</value>
+ <unit>-</unit>
+ </checked>
+ </climb_gradient_of_second_take_off_segment>
+ <climb_gradient_of_final_take_off_segment description="Switch if landing field length can be maintained">
+ <value>0</value>
+ <unit>-</unit>
+ <checked description="Indicates if the value has been checked against the requirement.">
+ <value>0</value>
+ <unit>-</unit>
+ </checked>
+ </climb_gradient_of_final_take_off_segment>
+ <climb_gradient_approach_one_engine_inoperative description="Switch if landing field length can be maintained">
+ <value>0</value>
+ <unit>-</unit>
+ <checked description="Indicates if the value has been checked against the requirement.">
+ <value>0</value>
+ <unit>-</unit>
+ </checked>
+ </climb_gradient_approach_one_engine_inoperative>
+ <climb_gradient_all_engines_operative description="Switch if landing field length can be maintained">
+ <value>0</value>
+ <unit>-</unit>
+ <checked description="Indicates if the value has been checked against the requirement.">
+ <value>0</value>
+ <unit>-</unit>
+ </checked>
+ </climb_gradient_all_engines_operative>
+ </certification>
+ </requirement_compliance>
+ </analysis>
+ <assessment>
+ <performance>
+ <speed tool_level="0">
+ <maximum_operating_mach_number description="Maximum operating mach number">
+ <value>0</value>
+ <unit>-</unit>
+ </maximum_operating_mach_number>
+ <maximum_operating_velocity description="Maximum oderating speed (maximum dynamic pressure)">
+ <value>0</value>
+ <unit>m/s</unit>
+ </maximum_operating_velocity>
+ <dive_mach_number description="Diving mach number">
+ <value>0</value>
+ <unit>-</unit>
+ </dive_mach_number>
+ <dive_velocity description="Diving speed">
+ <value>0</value>
+ <unit>m/s</unit>
+ </dive_velocity>
+ <one_g_stall_speed_velocity description="One g stall speed in clean configuration">
+ <value>0</value>
+ <unit>m/s</unit>
+ </one_g_stall_speed_velocity>
+ </speed>
+ <take_off tool_level="0">
+ <take_off_distance_normal_safety description="Takeoff distance at Sea Level for MTOM and (ISA + deltaISA)-Conditions(calculated by missionAnalysis using missionDesign.xml settings) with all engines operating (AEO)">
+ <value>0</value>
+ <unit>m</unit>
+ </take_off_distance_normal_safety>
+ <lift_off_speed_velocity Alt="v_lof" description="Lift-off speed in take-off configuration">
+ <value>0</value>
+ <unit>m/s</unit>
+ </lift_off_speed_velocity>
+ <decision_speed Alt="v_1" description="Decision speed">
+ <value>0</value>
+ <unit>m/s</unit>
+ </decision_speed>
+ <take_off_safety_speed Alt="v_2" description="Speed at screen height (35 ft)">
+ <value>0</value>
+ <unit>m/s</unit>
+ </take_off_safety_speed>
+ <final_take_off_speed Alt="v_FTO" description="Speed at final takeoff segment (1500 ft)">
+ <value>0</value>
+ <unit>m/s</unit>
+ </final_take_off_speed>
+ <time_to_screen_height description="Time to screen height">
+ <value>0</value>
+ <unit>s</unit>
+ </time_to_screen_height>
+ <climb_or_descend_segment_climb_gradient description="Climb gradient in second takeoff segment">
+ <value>0</value>
+ <unit>%</unit>
+ </climb_or_descend_segment_climb_gradient>
+ <final_segment_climb_gradient description="Climb gradient in final takeoff segment">
+ <value>0</value>
+ <unit>%</unit>
+ </final_segment_climb_gradient>
+ <balanced_field_length description="Balanced field length">
+ <value>0</value>
+ <unit>m</unit>
+ </balanced_field_length>
+ </take_off>
+ <landing tool_level="0">
+ <needed_runway_length description="Needed runway length with all engines operating and maximum landing mass">
+ <value>0</value>
+ <unit>m</unit>
+ </needed_runway_length>
+ <approach_speed description="Final approach speed in landing configuration and maximum landing mass">
+ <value>0</value>
+ <unit>m/s</unit>
+ </approach_speed>
+ </landing>
+ <range tool_level="0">
+ <range_max_payload_at_maximum_take_off_mass description="Range at maximum payload and fuel mass till maximum take off mass limit">
+ <value>3246.489365</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </range_max_payload_at_maximum_take_off_mass>
+ <range_max_fuel_at_maximum_take_off_mass description="Range at full tanks and payload till maximum take off mass limit">
+ <value>10458.54652</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </range_max_fuel_at_maximum_take_off_mass>
+ <payload_maximum_fuel_at_maximum_take_off_mass description="Payload at full tanks and payload till maximum take off mass limit">
+ <value>4361.39852</value>
+ <unit>kg</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </payload_maximum_fuel_at_maximum_take_off_mass>
+ <range_maximum_fuel_empty description="Range for no payload and full tanks">
+ <value>10708.77812</value>
+ <unit>m</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </range_maximum_fuel_empty>
+ </range>
+ </performance>
+ <average_temperature_response description="Integrated temperature change per year caused by aircraft operation divided by operating lifetime" tool_level="2">
+ <value>0</value>
+ <unit>K</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>1e-5</upper_boundary>
+ </average_temperature_response>
+ <operating_cost_estimation_tu_berlin description="Operating costs (sum of direct and indirect operating costs)" tool_level="2">
+ <direct_operating_costs description="Direct operating costs (sum of route independent and route dependent costs)">
+ <direct_operating_costs_annual description="Direct operating costs (DOC) per year">
+ <value>30</value>
+ <unit>EUR/y</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </direct_operating_costs_annual>
+ </direct_operating_costs>
+ <indirect_operating_costs description="Indirect operating costs (IOC)">
+ <indirect_operating_costs_annual description="Indirect operating costs (IOC) per year">
+ <value>40</value>
+ <unit>EUR/y</unit>
+ <lower_boundary>0</lower_boundary>
+ <upper_boundary>inf</upper_boundary>
+ </indirect_operating_costs_annual>
+ </indirect_operating_costs>
+ </operating_cost_estimation_tu_berlin>
+ </assessment>
+</aircraft_exchange_file>
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/reporting/plots/[module name]_[name of plot].txt b/docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/reporting/plots/[module name]_[name of plot].txt
new file mode 100644
index 0000000..e69de29
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/reporting/report_xml/cost_estimation_results.xml b/docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/reporting/report_xml/cost_estimation_results.xml
new file mode 100644
index 0000000..7266cf6
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/projects/CSR/CSR-02/reporting/report_xml/cost_estimation_results.xml
@@ -0,0 +1,46 @@
+<module_results_file Name="Cost estimation specific outputs">
+ <general_information description="General information on module execution">
+ <workflow_version description="Version number of the current workflow">
+ <value>2.1.0</value>
+ </workflow_version>
+ <execution_date description="Execution date and time of the code">
+ <value>2024-11-18_10-48-55</value>
+ </execution_date>
+ <project_name description="Name of the current aircraft project">
+ <value>CSR-02</value>
+ </project_name>
+ <method_name description="Name of current module calculation method">
+ <value>operating_cost_estimation_tu_berlin</value>
+ </method_name>
+ <routing_layer description="Routing layer information">
+ <layer_1 description="Routing layer_1">
+ <value>tube_and_wing</value>
+ </layer_1>
+ <layer_2 description="Routing layer_2">
+ <value>empirical</value>
+ </layer_2>
+ <layer_3 description="Routing layer_3">
+ <value>operating_cost_estimation_tu_berlin</value>
+ </layer_3>
+ <user_layer description="Routing user_layer">
+ <value>kerosene</value>
+ </user_layer>
+ </routing_layer>
+ </general_information>
+ <calculation_results description="Results of calculation method">
+ <operating_cost_estimation_tu_berlin description="Empirical method to estimate the direct operating costs (DOC) and indirect operating costs (IOC) of an aircraft.">
+ <design_mission description="Cost estimation results of the design mission">
+ <direct_operating_costs description="Direct operating costs">
+ <direct_operating_costs_per_year description="Direct operating costs per year at design point (sum of route dependent and route independent costs)">
+ <value>30</value>
+ <unit>EUR</unit>
+ </direct_operating_costs_per_year>
+ </direct_operating_costs>
+ <indirect_operating_costs description="Indirect operating costs">
+ <value>40</value>
+ <unit>EUR</unit>
+ </indirect_operating_costs>
+ </design_mission>
+ </operating_cost_estimation_tu_berlin>
+ </calculation_results>
+</module_results_file>
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/CMakeLists.txt b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/CMakeLists.txt
new file mode 100644
index 0000000..c590f28
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/CMakeLists.txt
@@ -0,0 +1,4 @@
+# Add the package to the package list for exporting the target
+# and propagate the resulting list back to the parent scope
+list( APPEND PYTHON_TARGETS ${CMAKE_CURRENT_LIST_DIR} )
+set( PYTHON_TARGETS ${PYTHON_TARGETS} PARENT_SCOPE )
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/LICENSE b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/LICENSE
new file mode 100644
index 0000000..c2e9f6c
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ UNICADO - Modular Preliminary Aircraft Design Tool
+ Copyright (C) 2024
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/README.md b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/README.md
new file mode 100644
index 0000000..3eb3604
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/README.md
@@ -0,0 +1,31 @@
+# UNICADO Python Framework
+
+Brief description of what the project does and its purpose.
+
+## Installation (standalone)
+Please follow the instructions on the UNICADO website:
+https://unicado.ilr.rwth-aachen.de/w/software_maintenance/how_to_python_in_unicado/
+
+## Usage
+Explain how to use the project. Provide examples if necessary.
+
+## Configuration
+Explain any configuration options or settings that can be customized.
+
+## Contributing
+If you'd like to contribute to this project, please follow these guidelines:
+
+Fork the repository.
+Create a new branch (git checkout -b feature_branch).
+Make your changes and commit them (git commit -am 'Add new feature').
+Push to the branch (git push origin feature_branch).
+Create a new Pull Request.
+
+## License
+This project is licensed under the GNU General Public License, Version 3 - see the LICENSE.md file for details.
+
+## Acknowledgements
+List any acknowledgements or credits for libraries, tutorials, etc. that were used in developing this project.
+
+## Contact
+For questions or feedback, please contact A. Gobbin (a.gobbin@tu-berlin.de) or S. Roscher (s.roscher@tu-berlin.de).
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/pyproject.toml b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/pyproject.toml
new file mode 100644
index 0000000..ebb3fbb
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/pyproject.toml
@@ -0,0 +1,20 @@
+[build-system]
+# Please do not change any information given here.
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pymodulepackage" # insert name of the package (all lowercase, without underscores or special characters)
+version = "2.0.1" # insert version of package
+description = "This package contains standardized functions for UNICADO module execution." # Insert short package description
+readme = "README.md"
+requires-python = ">=3.10"
+license = {file = "LICENSE"}
+authors = [ # Insert name of author(s)
+ {name = "A. Gobbin", email = "a.gobbin@tu-berlin.de"},
+ {name = "S. Roscher", email = "s.roscher@tu-berlin.de"}
+]
+
+[project.urls]
+homepage = "https://unicado.ilr.rwth-aachen.de/"
+repository = "https://git.rwth-aachen.de/unicado"
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/datapostprocessingmodule.py b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/datapostprocessingmodule.py
new file mode 100644
index 0000000..9a4f587
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/datapostprocessingmodule.py
@@ -0,0 +1,930 @@
+"""Module providing general UNICADO data postprocessing functions for Python code."""
+# Import standard modules.
+import os
+import re
+import sys
+import collections
+import xml.etree.ElementTree as ET
+from datetime import datetime
+
+
+def create_element_tree_from_paths(input_dict):
+ """ Create element tree from paths.
+
+ This function creates an element tree from the xml-paths inside the given input dictionary.
+
+ :param root input_dict: Dict containing module specific output datas.
+ :return: root
+ """
+ ''' initialize local parameter '''
+ paths = []
+ values = []
+
+ # Generate lists of paths and values
+ for _, value in input_dict.items():
+ paths.append(value[0])
+ values.append(value[1])
+
+ # Create the root element.
+ root_name = paths[0].split('/')[1]
+ root = ET.Element(root_name)
+
+ # Build the XML tree.
+ for index, path in enumerate(paths):
+ # Split the path into parts.
+ parts = re.split(r'\/(?![^\[]*\])', path.lstrip('./'))
+ current_element = root
+
+ for part in parts:
+ # Check if part has an ID attribute
+ id_match = re.search(r'(.+?)\[@ID="(\d+)"\]', part)
+ if id_match:
+ tag, id_value = id_match.groups()
+ # Check if an element with the same tag and ID already exists.
+ existing_element = current_element.find(f"./{tag}[@ID='{id_value}']")
+ if existing_element is not None:
+ current_element = existing_element
+ else:
+ new_element = ET.SubElement(current_element, tag, ID=id_value)
+ current_element = new_element
+ else:
+ # Check if an element with the same tag already exists.
+ existing_element = current_element.find(part)
+ if existing_element is not None:
+ current_element = existing_element
+ else:
+ new_element = ET.SubElement(current_element, part)
+ current_element = new_element
+
+ # Add 'value' sub-node with None as text content to the end node.
+ value_node = ET.SubElement(current_element, 'value')
+ value_node.text = str(values[index])
+
+ return root
+
+
+def insert_missing_elements(main_tree, root_of_tree_to_insert):
+ """ Insert missing elements.
+
+ This function searches and inserts missing module-dependent node elements in the aircraft exchange tree.
+
+ :param tree main_tree: The element tree into which all data from the second tree is to be inserted.
+ :param root root_of_tree_to_insert: The root node contains all the data to be inserted into the main tree.
+ :return: None
+ """
+ root = main_tree.getroot()
+
+ def insert_elements(first_parent, second_parent):
+ for second_child in second_parent:
+ # Find or create the corresponding child in the first tree
+ first_child = first_parent.find(second_child.tag)
+ if first_child is None:
+ # If the element doesn't exist in the first tree, append it
+ first_child = ET.SubElement(first_parent, second_child.tag, attrib=second_child.attrib)
+ first_child.text = second_child.text
+ else:
+ # Update the attributes and text of the existing element
+ first_child.attrib.update(second_child.attrib)
+ if first_child.text is None:
+ first_child.text = second_child.text
+ elif second_child.text is not None:
+ first_child.text += second_child.text
+ # Recursively insert missing elements for child elements
+ insert_elements(first_child, second_child)
+
+ # Start recursive insertion from the roots
+ insert_elements(root, root_of_tree_to_insert)
+
+
+def find_and_remove_paths_in_tree(element_tree, cleaned_paths):
+ """ Find and remove paths in tree.
+
+ This function searches and removes given XML paths from a given element tree.
+ Attention: The function has different behavior for entries in the 'component_design' node. Due to the unknown
+ number of ID nodes, the entire module-dependent subtree is deleted here.
+ For all other nodes, only the target nodes are removed.
+
+ :param tree element_tree: Element tree containing all node datas.
+ :param list cleaned_paths: List containing all xml paths to remove.
+ :return: None
+ """
+ # Nested function to find parent node of current subtree node
+ def find_parent(root, element):
+ for parent in root.iter():
+ for child in parent:
+ if child == element:
+ return parent
+ return None
+
+ root = element_tree.getroot()
+ # Create map for parent-child relations.
+ parent_map = {c: p for p in element_tree.iter() for c in p}
+
+ # Loop across all paths to remove from aircraft exchange tree.
+ for path in cleaned_paths:
+ # Convert the './' prefixed path to the standard XPath by removing the leading './'.
+ xpath = path.lstrip('./')
+ # Get first node of current path.
+ first_node = xpath.split('/')[0]
+ # Check if the first node is not 'component_design' -> if true: -> remove only the end nodes of current path.
+ if not first_node == 'component_design':
+ # Find elements matching the XPath.
+ elements_to_remove = root.findall(xpath)
+ # Check each element if is existing -> if true: -> remove node from element tree
+ for elem in elements_to_remove:
+ parent = parent_map.get(elem)
+ if parent is not None:
+ parent.remove(elem)
+
+ # Else condition: the first node of current path is 'component_design'
+ # -> Remove all nodes from second node to end of current path.
+ else:
+ second_node = xpath.split('/')[1]
+ sub_tree_to_remove = root.find('component_design/' + second_node)
+ if sub_tree_to_remove is not None:
+ # Use a list to collect all descendants
+ elements_to_remove = []
+ stack = [sub_tree_to_remove]
+ while stack:
+ current_element = stack.pop()
+ elements_to_remove.append(current_element)
+ stack.extend(list(current_element))
+ # Remove all collected elements
+ for elem in elements_to_remove[::-1]:
+ # Call nested function to find parend node of current sub tree node.
+ parent = find_parent(root, elem)
+ if parent is not None:
+ parent.remove(elem)
+
+
+def convert_dictionary_to_element_tree(parameters_dict, parent=None):
+ """ Convert dictionary to element tree.
+
+ This function converts the module-dependent key parameter dict into a consistent module-dependent element tree.
+
+ :param dict parameters_dict: Dict containing parameter for the element tree to generate.
+ :param node parent: The Parent node element of current module key parameter.
+ :return: element parent
+ """
+ # Check if is parent is None -> if true: -> initialize root node of element tree as 'module_dependent_root'.
+ # Otherwise, the given parent is an ET.Element
+ if parent is None:
+ parent = ET.Element('module_dependent_root')
+
+ # Loop across the key value pairs of given dictionary to convert to an element tree.
+ for key, value in parameters_dict.items():
+ # Check if the current key is 'attribute' -> if true: -> set current value as an attribute of parent node
+ if key == 'attributes':
+ for attr_key, attr_value in value.items():
+ parent.set(attr_key, str(attr_value))
+ # Else if condition: Check if the current value is a dictionary -> if true: -> build sub-dictionary recursively.
+ elif isinstance(value, dict):
+ element = ET.Element(key)
+ parent.append(element)
+ # Call function for recursive tree building.
+ convert_dictionary_to_element_tree(value, element)
+ # Else condition: Current key value pair is an end-node -> set value of dictionary entry as text element.
+ else:
+ element = ET.SubElement(parent, key)
+ element.text = str(value)
+
+ return parent
+
+def convert_element_tree_to_dictionary(root_of_tree):
+ """ Converts an ElementTree or Element into a dictionary.
+
+ :param (xml.etree.ElementTree.Element): The root element to convert.
+ :return dict dictionary: A dictionary representation of the ElementTree.
+ """
+
+ def _etree_to_dict(tree):
+ dictionary = {tree.tag: {} if tree.attrib else None}
+ children = list(tree)
+ if children:
+ data_dict = {}
+ for data_child in map(_etree_to_dict, children):
+ for key, value in data_child.items():
+ if key in data_dict:
+ if isinstance(data_dict[key], list):
+ data_dict[key].append(value)
+ else:
+ data_dict[key] = [data_dict[key], value]
+ else:
+ data_dict[key] = value
+ dictionary = {tree.tag: data_dict}
+ if tree.attrib:
+ dictionary[tree.tag].update(('@' + key, value) for key, value in tree.attrib.items())
+ if tree.text:
+ text = tree.text.strip()
+ if children or tree.attrib:
+ if text:
+ dictionary[tree.tag]['#text'] = text
+ else:
+ dictionary[tree.tag] = text
+ return dictionary
+
+ return _etree_to_dict(root_of_tree)
+
+def get_paths_of_element_tree(element_tree, parent_path=""):
+ """ Get paths of element tree.
+
+ This function extracts all xml paths of the given element tree.
+
+ :param tree element_tree: The element tree containing the module dependent parameter.
+ :param string parent_path: The string contains the parent path of current element.
+ :return: list paths
+ """
+ paths = []
+ current_path = f"{parent_path}/{element_tree.tag}" if parent_path else element_tree.tag
+ # If the element has no children, add the current path to list of paths.
+ if len(element_tree) == 0:
+ paths.append(current_path)
+ # Run through the children recursively
+ for child in element_tree:
+ # Call function for recursive path generation.
+ paths.extend(get_paths_of_element_tree(child, current_path))
+
+ return paths
+
+
+def prepare_element_tree_for_module_key_parameter(paths_and_names, module_key_parameters_dict):
+ """Prepare element tree.
+
+ This function prepares the element tree for the current module.
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict module_key_parameters_dict: Dict containing information on module nodes in aircraft exchange file
+ :return: dict paths_and_names
+ """
+ # Call function to convert the module key parameter dict to a module dependent element tree.
+ module_dependent_tree = convert_dictionary_to_element_tree(module_key_parameters_dict)
+
+ # Call function to generate all xml path of the module dependent element tree.
+ element_tree_paths = get_paths_of_element_tree(module_dependent_tree)
+
+ # Sort the list of xml paths, delete duplicates and prepare for element tree operations.
+ cleaned_paths = sorted(list(set(['./' + '/'.join(path.split('/')[1:-1]) for path in element_tree_paths])))
+
+ # Call function to remove old elements from aircraft exchange tree.
+ find_and_remove_paths_in_tree(paths_and_names['root_of_aircraft_exchange_tree'], cleaned_paths)
+
+ # Call function to insert module dependent entries to the aircraft exchange tree.
+ insert_missing_elements(paths_and_names['root_of_aircraft_exchange_tree'], module_dependent_tree)
+
+ return paths_and_names
+
+
+def write_key_data_to_aircraft_exchange_file(root_of_aircraft_exchange_tree, path_to_aircraft_exchange_file,
+ paths_to_key_parameters_list, user_output_dict, tool_level,
+ runtime_output):
+ """Write key data to the aircraft exchange file.
+
+ This function takes key data, verifies and writes it to the aircraft exchange file.
+ (1) Preparation: Using the paths contained in the 'user_output_dict', a list with user paths is generated that
+ is subsequently cleaned of duplicates. Next, every path in the path list is assigned to one of the four
+ categories and appended to the corresponding list:
+ (a) user path already exists in aircraft exchange file ('paths_already_in_aircraft_exchange_file_list')
+ (b) valid user path ('valid_user_paths_list')
+ (c) invalid user path (invalid_user_paths_list)
+ (d) user paths that need further checks ('user_paths_to_check_list')
+ Note: Only the paths of the last category will be considered further in the following steps.
+ For further processing, the paths in 'user_paths_to_check_list' are sorted in ascending order according to
+ their IDs. In addition, all paths that have one or more IDs are then extracted from the key paths and appended
+ to 'key_paths_with_id_list' for further use.
+ (2) Path validation and key parameter check: One by one, each key path is generalized. This means that the
+ number(s) of the ID(s) contained are replaced by an 'X'. All user paths from 'user_paths_to_check_list' are
+ checked to see whether they match the pattern of the current generalized key path. All paths that match this
+ pattern are added to the 'matching_user_paths_list'. If there are matching user paths, the code performs
+ various checks to assign these user paths to either the 'valid_user_paths_list' or 'invalid_user_paths_list'.
+ The checks include examining the structure and values of IDs within the user paths. After processing the key
+ paths, the code checks for any user paths that are neither in the 'valid_user_paths_list' nor in the
+ 'invalid_user_paths_list'. These paths are considered invalid, and a warning is issued. If there are user path
+ errors, error messages are generated, and the program is prepared for possible abort. The code checks whether
+ all key parameters are written by the user. If any key parameter path is missing, an error message is issued.
+ If there are either user path errors or missing key path errors, the code generates error messages and,
+ depending on the error type, raises a ValueError exception. This exception serves as a signal to terminate the
+ program.
+ Note: Only the 'valid_user_path_list' will be considered further in the following steps.
+ (3) Initialization of tree structure: Ensure that all necessary paths exist in aircraft exchange file to enable
+ upcoming step. Furthermore, the values are checked to ensure that they are within the defined limits.
+ (4) Completion: Write to aircraft exchange file. If the file cannot be opened, an OSError is raised.
+
+ :param ElementTree root_of_aircraft_exchange_tree: Root of aircraft exchange file tree
+ :param str path_to_aircraft_exchange_file: Path to aircraft exchange file
+ :param list paths_to_key_parameters_list: List with paths to key parameters in aircraft exchange file
+ :param dict user_output_dict: Dictionary containing parameter name, path to parameter, and value of key parameters
+ :param int tool_level: Tool level of current module
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :raises ValueError: Raised if unsuccessful validation (faulty user paths, missing key paths or value out of limits)
+ or failed writing to the aircraft exchange file
+ :return: None
+ """
+
+ """Preparation."""
+ # Generate list with user defined paths in 'user_output_dict' and ensure operating system conformity for path
+ # separators.
+ user_defined_path_list = [user_output_dict[key][0].replace(os.sep, '/') for key in user_output_dict]
+ # Count the occurrences of each path.
+ path_counter = collections.Counter(user_defined_path_list)
+ duplicate_paths = [path for path, count in path_counter.items() if count > 1]
+ # Remove duplicates and generate a warning.
+ if duplicate_paths:
+ runtime_output.warning('Warning: Duplicate paths found. Removing the following duplicates:')
+ for duplicate_paths in duplicate_paths:
+ runtime_output.warning(' ' + f"Duplicate path: {duplicate_paths}")
+ user_defined_path_list.remove(duplicate_paths)
+
+ # Initialize local parameters that indicate which paths are valid, invalid, already in aircraft exchange file, and
+ # which need further checks.
+ valid_user_paths_list, invalid_user_paths_list, user_paths_to_check_list = [], [], []
+ paths_already_in_aircraft_exchange_file_list = []
+
+ # Iterate over all user defined paths in 'user_defined_path_list' and assign each path to one category.
+ for user_path in user_defined_path_list:
+ path_not_in_aircraft_exchange_file = False
+ # Check if user path (including 'value' sub-node) exists in aircraft exchange file and append to
+ # 'paths_already_in_aircraft_exchange_file_list' and 'valid_user_paths_list'.
+ if root_of_aircraft_exchange_tree.find(user_path + '/value') is not None:
+ paths_already_in_aircraft_exchange_file_list.append(user_path)
+ valid_user_paths_list.append(user_path)
+ # Else: Set 'path_not_in_aircraft_exchange_file' to 'True'.
+ else:
+ path_not_in_aircraft_exchange_file = True
+
+ # If path is not already contained in aircraft exchange file, append path to one of the following three lists:
+ # 'valid_user_paths_list', 'invalid_user_paths_list', or 'user_paths_to_check_list'.
+ if path_not_in_aircraft_exchange_file:
+ # If last character of 'user_path' is ']', path is considered invalid.
+ if user_path[-1] == ']':
+ invalid_user_paths_list.append(user_path)
+ continue
+ # Count the number of IDs in 'user_path' string.
+ user_path_id_count = user_path.count('[@ID="')
+ # If current user path is contained in list of key parameter paths, append user path to list of valid user
+ # paths.
+ if user_path in paths_to_key_parameters_list:
+ valid_user_paths_list.append(user_path)
+ # If current user path is not contained in list of key parameter paths and user path does not contain an
+ # ID, append user path to list of invalid user paths.
+ elif user_path not in paths_to_key_parameters_list and user_path_id_count == 0:
+ invalid_user_paths_list.append(user_path)
+ # If none of above criteria apply, the user path is appended to the list of paths that need further checks.
+ else:
+ user_paths_to_check_list.append(user_path)
+
+ # Extract the values after "@ID=" from the paths in the list of paths that need further checks and sort this list.
+ id_values = [int(re.search(r'@ID="(\d+)"', path).group(1)) for path in user_paths_to_check_list]
+ user_defined_path_list_sorted = [path for _, path in sorted(zip(id_values, user_paths_to_check_list))]
+
+ # Extract key paths that contain "@ID".
+ key_paths_with_id_list = [path for path in paths_to_key_parameters_list if re.search(r'@ID="\d+"', path)]
+
+ """Path validation and key parameter check."""
+ # Classify each existing user path into a category based on generalized key parameter paths and check for missing
+ # key parameter paths.
+ try:
+ # Initialization of variables for error tracking.
+ error_path_dict = {}
+ user_path_error = False
+ user_path_error_counter = 0
+ missing_key_path_error = False
+ # Iterate over key paths in list of key paths with IDs.
+ for current_key_path in key_paths_with_id_list:
+ # Check if current key path exists in 'valid_user_paths_list' (True/False).
+ key_path_exists_in_user_paths = current_key_path in valid_user_paths_list
+ # Define ID pattern to generalize "@ID" attribute in 'current_key_path' (replace ID number with 'X').
+ id_pattern = re.compile(r'@ID="(\d+)"')
+ # Store current generalized key parameter path.
+ current_generalized_key_path = re.sub(r'@ID="\d+"', '@ID="X"', current_key_path)
+ # Create empty list of matching user paths.
+ # Iterate over all user paths in sorted list of user defined paths.
+ # - Replace ID number with 'X' for generalization purposes.
+ # - Append all user paths that match the pattern of the current generalized key parameter path.
+ matching_user_paths_list = [user_path for user_path in user_defined_path_list_sorted if
+ re.sub(r'@ID="\d+"', '@ID="X"', user_path) == current_generalized_key_path]
+
+ # Sub function to sort all paths by his last ID entry in numerical order.
+ def extract_id(matching_user_paths_list):
+ matches = re.findall(r'@ID="(\d+)"', matching_user_paths_list)
+ return int(matches[-1]) if matches else float('inf')
+
+ # Sort the list by the extracted ID value.
+ matching_user_paths_list = sorted(matching_user_paths_list, key=extract_id)
+
+ # If any user paths match the current generalized key parameter path, various checks are performed to
+ # assign the corresponding user paths to either the "valid_user_paths_list" or the
+ # "invalid_user_paths_list".
+ if len(matching_user_paths_list) > 0:
+ # Create empty list of current user path IDs.
+ user_path_ids_list = []
+ # Iterate over list with user paths that match current key parameter path pattern and extract the
+ # values of contained IDs.
+ for current_matching_user_path in matching_user_paths_list:
+ # Find all IDs of current user path.
+ values_of_user_ids_list = re.findall(id_pattern, current_matching_user_path)
+ # Convert the numbers from strings to integers.
+ values_of_user_ids_list = [int(num) for num in values_of_user_ids_list]
+ # Generate list of IDs for current user path.
+ user_path_ids_list.append(values_of_user_ids_list)
+
+ # If the 'current_key_path' exists in 'valid_user_paths_list' and there are user path IDs, the IDs are
+ # compared and possible errors handled.
+ if key_path_exists_in_user_paths and len(user_path_ids_list) != 0:
+ # Create a list with n zeros (n corresponds to the number of IDs in the current generalized key
+ # parameter path) and store the list in which all IDs are zero as 'first_list'.
+ zero_list = [0 for _ in range(len(user_path_ids_list[0]))]
+ user_path_ids_list.insert(0, zero_list)
+ first_list = user_path_ids_list[0]
+ # Check each position in the lists.
+ for i in range(1, len(user_path_ids_list)):
+ # Check whether the first element of the previous list is NOT the same as the first element of
+ # the current list.
+ if first_list != user_path_ids_list[i]:
+ # If the two IDs differ by more than 1, add the path to the list of invalid paths and go on
+ # with the next generalized key parameter path.
+ if abs(sum(first_list) - sum(user_path_ids_list[i])) > 1 \
+ and (abs(first_list[-1] - user_path_ids_list[i][-1]) > 1):
+ user_path_error_counter += 1
+ error_path_dict[current_generalized_key_path] = matching_user_paths_list[i-1:]
+ [invalid_user_paths_list.append(matching_user_paths_list[j])
+ for j in range(0, len(matching_user_paths_list))]
+ break
+ # If the first ID differs by 1 compared to the previous path, then a check of the following
+ # IDs is performed.
+ else:
+ valid_user_paths_list.append(matching_user_paths_list[i-1])
+ first_list = user_path_ids_list[i]
+ # If the first ID of the current path matches the first ID of the previous path, the subsequent
+ # IDs are subjected to further checks.
+ else:
+ # If the difference between the two lists is greater than 1, append the current path to the
+ # list of invalid paths and continue with the next generalized key parameter path.
+ if abs(sum(first_list) - sum(user_path_ids_list[i])) > 1:
+ user_path_error_counter += 1
+ error_path_dict[current_generalized_key_path] = matching_user_paths_list[i-1:]
+ [invalid_user_paths_list.append(matching_user_paths_list[j])
+ for j in range(0, len(matching_user_paths_list))]
+ break
+ # If the difference between the two lists is less than or equal to 1, then append the
+ # current path to the list of valid paths.
+ elif abs(sum(first_list) - sum(user_path_ids_list[i])) <= 1:
+ valid_user_paths_list.append(matching_user_paths_list[i-1])
+ first_list = user_path_ids_list[i]
+ # If the 'current_key_path' exists in 'valid_user_paths_list', but there are no matching user paths, a
+ # warning is issued.
+ elif key_path_exists_in_user_paths and len(user_path_ids_list) == 0:
+ runtime_output.warning('Warning: No matching user paths according to key pattern: '
+ + current_generalized_key_path)
+ continue
+ # If the 'current_key_path' does not exist in 'valid_user_paths_list' and is not contained in
+ # 'paths_already_in_aircraft_exchange_file_list', a warning is issued and the current user paths are
+ # appended to the invalid paths.
+ elif not key_path_exists_in_user_paths \
+ and current_key_path not in paths_already_in_aircraft_exchange_file_list:
+ runtime_output.warning('Warning: Key path missing in user defined path list: ' + current_key_path)
+ user_path_error_counter += 1
+ error_path_dict[current_generalized_key_path] = matching_user_paths_list
+ [invalid_user_paths_list.append(matching_user_paths_list[j])
+ for j in range(0, len(matching_user_paths_list))]
+ continue
+
+ # After processing the key paths, it is checked for any user paths that are neither in 'valid_user_paths_list'
+ # nor in 'invalid_user_paths_list'. These paths are considered invalid, and a warning is issued.
+ for tmp_path in user_defined_path_list_sorted:
+ if tmp_path not in valid_user_paths_list and tmp_path not in invalid_user_paths_list:
+ invalid_user_paths_list.append(tmp_path)
+ runtime_output.warning(
+ ('Warning: The path "' + tmp_path + '" is not a key value and therefore not written to aircraft '
+ 'exchange file. Please contact module manager for further instructions.'))
+
+ # If there are user path errors, error messages are generated.
+ if user_path_error_counter > 0:
+ user_path_error = True
+ # Generate error messages.
+ for key, value in error_path_dict.items():
+ runtime_output.error('Error: The following user paths of the pattern "' + key + '" are invalid:')
+ for i, value in enumerate(value):
+ runtime_output.error(' ' + value)
+ user_path_error_string = 'Please change user paths according to style guidelines.'
+
+ # Check whether all key parameters are written by the user.
+ missing_key_path_list = []
+ missing_key_path_error_string = str()
+ for tmp_key_path in paths_to_key_parameters_list:
+ # If a key parameter path is missing, an error message is issued.
+ if tmp_key_path not in valid_user_paths_list:
+ runtime_output.error('Error: The following key parameter is not set: ' + tmp_key_path)
+ missing_key_path_list.append(tmp_key_path)
+ # If there are missing key path errors, error messages are generated.
+ if len(missing_key_path_list) != 0:
+ missing_key_path_error = True
+ missing_key_path_error_string = 'Please make sure to write all necessary key parameters of your method.'
+
+ # If there are user path errors or missing key path errors, error messages are generated and the program is
+ # aborted with a ValueError exception.
+ if user_path_error or missing_key_path_error:
+ if user_path_error and not missing_key_path_error:
+ raise ValueError(user_path_error_string + ' Program aborted!')
+ elif not user_path_error and missing_key_path_error:
+ raise ValueError(missing_key_path_error_string + ' Program aborted!')
+ else:
+ raise ValueError(user_path_error_string[:-1] + ' and ' + missing_key_path_error_string.lower()
+ + ' Program aborted!')
+
+ # Exception handling for value error.
+ except ValueError as e:
+ runtime_output.critical('Error: ' + str(e))
+ sys.exit(1)
+
+ """Initialization of tree structure."""
+ # Initialization.
+ component_layer_old = str()
+ sub_node_list = ['value', 'unit', 'lower_boundary', 'upper_boundary']
+ # Extract the corresponding dictionary entries to the valid user paths.
+ valid_key_dict = {key: value for (key, value) in user_output_dict.items()
+ if user_output_dict[key][0] in valid_user_paths_list}
+
+ # Create all necessary nodes in the aircraft exchange file and check whether the results are within the expected
+ # limits.
+ try:
+ # Iterate over all parameters in 'valid_key_dict'.
+ for key in valid_key_dict:
+ # Extract path.
+ tmp_string = valid_key_dict[key][0]
+ # Split 'tmp_string' at operating system separator.
+ parts_list = tmp_string.split('/')
+ # Delete all empty list entries if existing.
+ filtered_parts = [part for part in parts_list if part]
+ # Store third element as 'component_layer'.
+ component_layer = filtered_parts[2]
+ # Initialization of necessary variables.
+ parent_path = []
+ path_to_check = '.'
+ first_id_parent = []
+ tmp_zero_path = str()
+ path_contains_id = False
+ # Check if the current part of string is existing in the aircraft exchange ElementTree.
+ for part in filtered_parts[1:]:
+ # Extend the 'path_to_check' with the current 'part'.
+ path_to_check = os.path.join(path_to_check, part).replace(os.sep, '/')
+ # Check if the path exist in aircraft exchange ElementTree.
+ path_flag = root_of_aircraft_exchange_tree.find(path_to_check)
+ # Check if the 'component_layer' is the same as the 'component_layer_old'.
+ same_component_layer = component_layer == component_layer_old
+ # Set 'tool_level' attribute if path exists, the current part equals 'component_layer', and if the
+ # 'component_layer' is different from the previous one.
+ if path_flag is not None and part == component_layer and not same_component_layer:
+ path_flag.set('tool_level', tool_level)
+ component_layer_old = component_layer
+ # Add the current part of string to the ElementTree as a new sub-node if the node does not exist.
+ if path_flag is None:
+ # Check if current part of string contains '@' (indicating ID).
+ if '@' in part:
+ # Set flag if string contains '@'.
+ path_contains_id = True
+ if len(first_id_parent) == 0:
+ first_id_parent = parent_path
+ # Handle attribute 'ID' (extract 'ID' and value of ID, generate new sub-node under current
+ # 'parent_path', and set attribute 'ID' with according value).
+ attribute_name, attribute_value = part.split('=')
+ attribute_name = attribute_name.split('[@')
+ attribute_id = attribute_name[1]
+ attribute_value = attribute_value[attribute_value.find('"')+1:attribute_value.rfind('"')]
+ node_name = attribute_name[0]
+ new_node = ET.SubElement(parent_path, node_name)
+ new_node.set(attribute_id, attribute_value)
+ # Handle attribute 'description' (set the description to description of the 'tmp_zero_path').
+ tmp_pattern = r'"(.*?)"'
+ tmp_zero_path = re.sub(tmp_pattern, '"0"', path_to_check)
+ tmp_description = root_of_aircraft_exchange_tree.find(tmp_zero_path).get('description')
+ new_node.set('description', tmp_description)
+ # Current path does not contain '@'.
+ else:
+ if len(tmp_zero_path) != 0:
+ tmp_zero_path = tmp_zero_path + '/' + part
+ else:
+ tmp_pattern = r'"(.*?)"'
+ tmp_zero_path = re.sub(tmp_pattern, '"0"', path_to_check)
+ path_contains_id = True
+ element_to_add = ET.Element(part)
+ # Check if description exists.
+ if path_to_check == './component_design/fuselage/specific/geometry/fuselage[@ID="0"]/mass_breakdown/fuselage_furnishing/component_mass[@ID="0"]/mass':
+ formatted_xml = ET.tostring(root_of_aircraft_exchange_tree.getroot(), encoding='unicode', method='xml')
+ formatted_xml_with_indent = minidom.parseString(formatted_xml).toprettyxml(indent=" ")
+ # Ausgabe
+ print(formatted_xml_with_indent)
+ print(path_to_check)
+ description_of_zero_path = \
+ root_of_aircraft_exchange_tree.find(tmp_zero_path).get('description')
+ element_to_add.set('description', description_of_zero_path)
+ # Append 'element_to_add' to 'parent_path'.
+ parent_path.append(element_to_add)
+ parent_path = root_of_aircraft_exchange_tree.find(path_to_check)
+ # Check if the current 'part' is the last element in the 'filtered_parts' list.
+ if part == filtered_parts[-1]:
+ # Check if 'path_to_check' contains an ID.
+ if path_contains_id:
+ # Check if 'path_to_check' is not equal to 'tmp_zero_path'.
+ if path_to_check != tmp_zero_path:
+ # Check if the current parameter not is not 'name'
+ # -> if true: -> add all sub nodes to current paramter
+ if part != 'name':
+ # Iterate through 'sub_node_list'.
+ for sub_node in sub_node_list:
+ # Check if 'sub-node' exists in 'tmp_zero_path'.
+ tmp_sub_node_exists_in_zero_path = \
+ root_of_aircraft_exchange_tree.find(tmp_zero_path + '/' + sub_node)
+ if tmp_sub_node_exists_in_zero_path is not None:
+ # Create new XML subelement with same name as 'sub_node' under 'parent_path'.
+ ET.SubElement(parent_path, sub_node)
+ # Get associated element. Set text to text of element in 'tmp_zero_path/sub_node'.
+ tmp_path = root_of_aircraft_exchange_tree.find(path_to_check + '/' + sub_node)
+ if sub_node == 'value':
+ tmp_path.text = str(user_output_dict[key][1])
+ else:
+ tmp_path.text = str(root_of_aircraft_exchange_tree.find(
+ tmp_zero_path + '/' + sub_node).text)
+ # Else condition: The current parameter not is 'name'
+ # -> add only 'value' sub note to current parameter
+ else:
+ # Check if 'value' exists in 'tmp_zero_path'.
+ tmp_sub_node_exists_in_zero_path = \
+ root_of_aircraft_exchange_tree.find(tmp_zero_path + '/value')
+ if tmp_sub_node_exists_in_zero_path is not None:
+ # Create new XML subelement with same name as 'sub_node' under 'parent_path'.
+ ET.SubElement(parent_path, 'value')
+ # Get associated element. Set text to text of element in 'tmp_zero_path/sub_node'.
+ tmp_path = root_of_aircraft_exchange_tree.find(path_to_check + '/value')
+ tmp_path.text = str(user_output_dict[key][1])
+ # 'path_to_check' does not contain an ID.
+ else:
+ # Find the XML element at 'path_to_check' + '/value'.
+ tmp_path = root_of_aircraft_exchange_tree.find(path_to_check + '/value')
+ # Get value associated with the key from 'user_output_dict'.
+ tmp_value = user_output_dict[key][1]
+ # Find lower and upper boundary elements.
+ lower_boundary = root_of_aircraft_exchange_tree.find(path_to_check + '/lower_boundary')
+ upper_boundary = root_of_aircraft_exchange_tree.find(path_to_check + '/upper_boundary')
+ # Check if lower and upper boundaries are checkable (checkable means not None and not "None").
+ lower_boundary_checkable = lower_boundary is not None and \
+ (lower_boundary.text is not None and lower_boundary.text != 'None')
+ upper_boundary_checkable = upper_boundary is not None and \
+ (upper_boundary.text is not None and upper_boundary.text != 'None')
+ # Check if the value falls below the lower boundary (if checkable).
+ if lower_boundary_checkable and tmp_value < float(lower_boundary.text):
+ raise ValueError('The value of the parameter ' + str(key) + ' = ' + str(tmp_value)
+ + ' falls below the given lower boundary of ' + lower_boundary.text
+ + '. Program aborted!')
+ # Check if the value exceeds the upper boundary (if checkable).
+ if upper_boundary_checkable and tmp_value > float(upper_boundary.text):
+ raise ValueError('The value of the parameter ' + str(key) + ' = ' + str(tmp_value) +
+ ' exceeds the given upper boundary of ' + upper_boundary.text
+ + '. Program aborted!')
+ # If no boundary conditions were violated, set tmp_path.text to the value.
+ tmp_path.text = str(tmp_value)
+
+ # Sort all child nodes alphabetically according to their tags.
+ sort_root = first_id_parent
+ children = list(sort_root)
+ children.sort(key=lambda x: x.tag)
+ # Delete all child nodes from root element.
+ for child in children:
+ sort_root.remove(child)
+ # Add the sorted child nodes back to the root element.
+ for child in children:
+ sort_root.append(child)
+
+ # Exception handling for value error.
+ except ValueError as e:
+ runtime_output.critical('Error:' + str(e))
+ sys.exit(1)
+
+ """Completion."""
+ # Ensure proper indentation.
+ ET.indent(root_of_aircraft_exchange_tree, space=" ", level=0)
+ # Write all key parameters to aircraft exchange file.
+ try:
+ # Write data to file.
+ root_of_aircraft_exchange_tree.write(path_to_aircraft_exchange_file, encoding='utf-8')
+ # Exception handling for operating system error.
+ except OSError:
+ runtime_output.critical('Error: Writing to aircraft exchange file failed. Program aborted!')
+ sys.exit(1)
+
+
+def method_data_postprocessing(paths_and_names, routing_dict, data_dict, method_specific_output_dict, runtime_output):
+ """General data postprocessing for current calculation method.
+
+ This function executes the method's own postprocessing. It is divided into general postprocessing and user layer
+ specific postprocessing:
+ - General postprocessing: The general postprocessing contains operations that are always carried out regardless
+ of the user layer. This includes general reports and plots.
+ - User layer specific postprocessing: Specific postprocessing includes, for example, plots that can/should only
+ be created if the user layer contains a certain value. The same applies to reports with values that are only
+ determined for certain user layer values.
+ Note that it may also be possible that the specific part is omitted, as the entire postprocessing is independent of
+ the user layer.
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing routing parameters
+ :param dict data_dict: Dictionary containing results of module execution
+ :param dict method_specific_output_dict: Dictionary containing method-specific output data
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :raises OSError: Raised if any method-specific postprocessing function fails
+ :return: None
+ """
+
+ # Read output switches from module configuration file.
+ root_of_module_config_tree = paths_and_names['root_of_module_config_tree']
+ plot_switch = (eval(root_of_module_config_tree.find('.//plot_output/enable/value').text.capitalize()))
+ html_switch = eval(root_of_module_config_tree.find('.//report_output/value').text.capitalize())
+ tex_switch = eval(root_of_module_config_tree.find('.//tex_report/value').text.capitalize())
+ if root_of_module_config_tree.find('.//xml_output/value') is not None:
+ xml_export_switch = eval(root_of_module_config_tree.find('.//xml_output/value').text.capitalize())
+ else:
+ xml_export_switch = False
+
+ # Plot functionality.
+ if plot_switch:
+ if not os.path.isdir(paths_and_names['project_directory'] + '/reporting/plots'):
+ os.makedirs(paths_and_names['project_directory'] + '/reporting/plots')
+ try:
+ # Run 'method_plot' from 'methodplot.py'.
+ routing_dict['func_user_method_plot'](paths_and_names, routing_dict, data_dict, method_specific_output_dict,
+ runtime_output)
+ except OSError as e:
+ runtime_output.error(str(e) + '\n '
+ + ' '
+ + 'Error: "method_plot" function failed. No plots generated and saved.')
+ else:
+ runtime_output.warning('Warning: "plot_output" switch in module configuration file set to "False". '
+ + 'No plots generated.')
+
+ # HTML report functionality.
+ if html_switch:
+ if not os.path.isdir(paths_and_names['project_directory'] + '/reporting/report_html'):
+ os.makedirs(paths_and_names['project_directory'] + '/reporting/report_html')
+
+ try:
+ # Run 'method_html_report' from 'methodhtmlreport.py'.
+ routing_dict['func_user_method_html_report'](paths_and_names, routing_dict, data_dict,
+ method_specific_output_dict, runtime_output)
+ except OSError as e:
+ runtime_output.error(str(e) + '\n '
+ + ' '
+ + 'Error: "method_html_report" function failed. '
+ + 'No additional data written to HTML report file.')
+ else:
+ runtime_output.warning(
+ 'Warning: "html_output" switch in module configuration file set to "False". No HTML report generated.'
+ )
+
+ # XML export functionality.
+ if xml_export_switch:
+ if not os.path.isdir(paths_and_names['project_directory'] + '/reporting/report_xml'):
+ os.makedirs(paths_and_names['project_directory'] + '/reporting/report_xml')
+
+ xml_export_tree, path_to_results_file = prepare_method_specific_xml_file(paths_and_names, routing_dict,
+ runtime_output)
+ try:
+ # Run 'method_xml_export' from 'methodxmlexport.py'.
+ routing_dict['func_user_method_xml_export'](paths_and_names, routing_dict, data_dict,
+ method_specific_output_dict, xml_export_tree,
+ path_to_results_file, runtime_output)
+ except OSError as e:
+ runtime_output.error(str(e) + '\n '
+ + ' '
+ + 'Error: "method_xml_export" function failed. '
+ + 'No additional data written to module specific XML results file.'
+ )
+ else:
+ runtime_output.warning('Warning: "xml_output" switch in module configuration file set to "False". '
+ + 'No XML results file generated.')
+
+ # TeX output functionality.
+ if tex_switch:
+ if not os.path.isdir(paths_and_names['project_directory'] + '/reporting/report_tex'):
+ os.makedirs(paths_and_names['project_directory'] + '/reporting/report_tex')
+
+ try:
+ # Run 'method_tex_output' from 'methodtexoutput.py'.
+ routing_dict['func_user_method_tex_output'](paths_and_names, routing_dict, data_dict,
+ method_specific_output_dict, runtime_output)
+ except OSError as e:
+ runtime_output.error(str(e) + '\n '
+ + ' '
+ + 'Error: "method_tex_output" function failed. '
+ + 'No TeX report file generated.'
+ )
+ else:
+ runtime_output.warning(
+ 'Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.')
+
+
+def prepare_method_specific_xml_file(paths_and_names, routing_dict, runtime_output):
+ """Generate XML file with general information on module execution to prepare the method-specific data output.
+
+ This function generates the basic structure of an XML file that is intended for the export of method-specific data.
+ This involves the following steps:
+ (1) Generate the file and module name as well as the path to the results file using information provided by the
+ 'paths_and_names' dictionary.
+ (2) Delete older versions of the file (if existing).
+ (3) Create the XML structure
+ 3.1) Create a 'general_information' block that contains the following information:
+ - Version of the current UNICADO workflow
+ - Code execution date and time
+ - Current aircraft project name
+ - Calculation method name
+ 3.2) Create a 'routing_layer' block that contains information on the current routing layers.
+ 3.3) Create a 'calculation_results' block that serves as a placeholder for the subsequent export of data
+ (if desired)
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing routing parameters
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :raises OSError: Raised if workflow version file not found
+ :returns:
+ - ElementTree xml_export_tree: Element tree of method-specific XML tree
+ - str path_to_results_file: Path to method-specific output XML file
+ """
+
+ # Initialize parameters.
+ file_name = paths_and_names['tool_name'] + '_results.xml'
+ module_name = paths_and_names['tool_name'].replace('_', ' ').capitalize()
+ path_to_results_file = paths_and_names["project_directory"] + '/reporting/report_xml/' + file_name
+
+ # Delete older output file if existing.
+ if os.path.isfile(path_to_results_file):
+ os.remove(path_to_results_file)
+
+ # Create directory for xml reports, if not existing
+ os.makedirs(paths_and_names["project_directory"] + '/reporting/report_xml/', exist_ok = True)
+
+ # Generate new ElementTree.
+ xml_export_root = ET.Element("module_results_file")
+ # Set name of current tool 'Name' of root element and generate ElementTree.
+ xml_export_root.set("Name", module_name + " specific outputs")
+ xml_export_tree = ET.ElementTree(xml_export_root)
+ # Add 'general_information' sub-node.
+ child = ET.SubElement(xml_export_root, "general_information")
+ child.set("description", "General information on module execution")
+
+ try:
+ # Initialize general information parameters.
+ if os.path.isfile(paths_and_names['working_directory'] + '/version.txt'):
+ # Open file and read version information.
+ with open(paths_and_names['working_directory'] + '/version.txt', 'r') as file:
+ # Read first line.
+ workflow_version = file.readline()
+ else:
+ workflow_version = "not available"
+ except OSError as e:
+ runtime_output.warning('Warning: ' + str(e) + ' \n'
+ + ' '
+ + 'Workflow version file not found.')
+
+ execution_date = datetime.now().strftime('%Y-%m-%d_%H-%M-%S')
+ root_of_module_config_tree = paths_and_names['root_of_module_config_tree']
+ project_name = (
+ root_of_module_config_tree.find('./control_settings/aircraft_exchange_file_name/value').text.split(".xml"))[0]
+ method_name = root_of_module_config_tree.find('./program_settings/configuration/method_name/value').text
+ # Definition of subnodes of 'general_information'.
+ # Format: general_information_subnodes = { 'name_of_sub-node': [description, value], ...}
+ general_information_subnodes = {
+ 'workflow_version': ['Version number of the current workflow', workflow_version],
+ 'execution_date': ['Execution date and time of the code', execution_date],
+ 'project_name': ['Name of the current aircraft project', project_name],
+ 'method_name': ['Name of current module calculation method', method_name]
+ }
+ # Iterate over 'general_information_subnodes' dictionary and add all keys as children.
+ for key, value in general_information_subnodes.items():
+ # Create a subelement for each key.
+ key_element = ET.SubElement(child, key)
+ # Add an attribute "description" and set the value to the first entry of the value-list.
+ key_element.set("description", value[0])
+ # Add a subelement "value" and set the value as text.
+ value_element = ET.SubElement(key_element, "value")
+ value_element.text = value[1]
+ # Add routing layer block.
+ routing_layer_element = ET.SubElement(child, 'routing_layer')
+ routing_layer_element.set("description", "Routing layer information")
+ # Iterate over 'routing_dict' and add keys that contain 'layer' as children of 'routing_layer_element'.
+ for key, value in routing_dict.items():
+ if 'layer' in key:
+ key_element = ET.SubElement(routing_layer_element, key)
+ key_element.set("description", 'Routing ' + str(key))
+ value_element = ET.SubElement(key_element, "value")
+ value_element.text = value
+ # Add 'calculation_results' block.
+ child = ET.SubElement(xml_export_root, "calculation_results")
+ child.set("description", "Results of calculation method")
+
+ # Ensure proper indentation and write file.
+ ET.indent(xml_export_root, space=" ", level=0)
+ try:
+ xml_export_tree.write(path_to_results_file)
+ except OSError as e:
+ runtime_output.critical('Error: ' + str(e))
+ sys.exit(1)
+
+ return xml_export_tree, path_to_results_file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/datapreprocessingmodule.py b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/datapreprocessingmodule.py
new file mode 100644
index 0000000..26e7e6c
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/datapreprocessingmodule.py
@@ -0,0 +1,776 @@
+"""Module providing general UNICADO data preprocessing functions for Python code."""
+# Import standard modules.
+import os
+import re
+import sys
+import logging
+import xml.etree.ElementTree as ET
+from pathlib import Path
+from datetime import datetime
+from inspect import currentframe, getframeinfo
+from runtimeoutputmodule import configure_runtime_output
+
+
+def method_data_preprocessing(paths_and_names, routing_dict, runtime_output):
+ """General data preprocessing for current calculation method.
+
+ This function performs general data preprocessing on input data obtained from aircraft exchange and module
+ configuration files. It accomplishes the following tasks:
+ (1) Data preparation: Extract root elements of aircraft exchange and module configuration trees from
+ 'paths_and_names' dict. Invoke 'user_method_data_preparation' function, specified in 'routing_dict', to obtain
+ information on data to extract from these files, resulting in two dictionaries, namely the
+ 'data_to_extract_from_aircraft_exchange_dict' and the 'data_to_extract_from_module_configuration_dict'.
+ (2) Read values from XML files: Using the above defined dictionaries with information on parameters that must
+ be extracted from the aircraft exchange and module configuration file, the according values are read from the
+ respective files and stored in 'tmp_aircraft_exchange_dict' and 'tmp_module_configuration_dict'. These
+ temporary dictionaries have a specific format for each parameter, including the parameter's name, path, value,
+ lower boundary, and upper boundary:
+ tmp_dict = {'parameter_name_1': [path, expected data type, value, lower boundary, upper boundary],
+ 'parameter_name_2': [...],
+ ...}
+ (3) The code then iterates over both temporary dictionaries, type casts the values to their expected data types,
+ checks if the values are within specified lower and upper boundaries, and stores the checked values in a new
+ dictionary, 'dict_out_short'. This dictionary contains the values for the same parameters as the input
+ dictionaries but with checked and possibly modified values.
+ The code returns two dictionaries: 'short_aircraft_exchange_dict' and 'short_module_configuration_dict', that
+ represent the preprocessed data for the aircraft exchange and module configuration file, respectively. The
+ dictionaries represent condensed forms of the 'tmp_aircraft_exchange_dict' and the 'tmp_module_configuration_dict'
+ and are structured according to the following scheme:
+ dict = {'parameter_name_1': value, ...}
+
+ In the case of a multi-parameter (xml path contains '@ID' identifier), the value of the parameter key
+ ('parameter_name_1') contains a sub-dictionary with all existing parameter ID names ('parameter_name_1_ID...') and
+ its corresponding values.
+ dict = {'parameter_name_1': {'parameter_name_1_ID0': value, 'parameter_name_1_ID1': value}, ...}
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing information on necessary data from module configuration file
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :returns:
+ - dict short_aircraft_exchange_dict: Dict containing parameters and acc. values from aircraft exchange file
+ - dict short_module_configuration_dict: Dict containing parameters and acc. values from module config. file
+ """
+
+ """Data preparation."""
+ # Extract roots of aircraft exchange and module configuration file.
+ root_of_aircraft_exchange_tree = paths_and_names['root_of_aircraft_exchange_tree']
+ root_of_module_config_tree = paths_and_names['root_of_module_config_tree']
+ # Run 'user_method_data_preparation' from 'usermethoddatapreparation.py'.
+ data_to_extract_from_aircraft_exchange_dict, data_to_extract_from_module_configuration_dict \
+ = routing_dict['func_user_method_data_input_preparation'](routing_dict)
+
+ """Read values from XML files."""
+ # Read values from aircraft exchange and module configuration file.
+ tmp_aircraft_exchange_dict = read_values_from_xml_file(data_to_extract_from_aircraft_exchange_dict,
+ root_of_aircraft_exchange_tree, runtime_output)
+ tmp_module_configuration_dict = read_values_from_xml_file(data_to_extract_from_module_configuration_dict,
+ root_of_module_config_tree, runtime_output)
+
+ """Extract, compute (type cast), and check values from output dictionary."""
+ tmp_list = []
+ # Iterate over both dictionaries.
+ for tmp_dict in [tmp_aircraft_exchange_dict, tmp_module_configuration_dict]:
+ dict_out_short = {}
+ multi_parameter_dict = {}
+ # Iterate over all elements of current dictionary.
+ for key in tmp_dict.keys():
+ # Extract and compute values.
+ parameter_name = key
+ expected_data_type = tmp_dict[key][1]
+ # Check if the current expected data type is not tool_level.
+ if expected_data_type != 'tool_level':
+ value = convert_string_to_expected_data_type(
+ tmp_dict[key][-3], expected_data_type, parameter_name,
+ runtime_output)
+ lower_boundary = convert_string_to_expected_data_type(tmp_dict[key][-2], expected_data_type,
+ ("lower_boundary_of_" + parameter_name),
+ runtime_output)
+ upper_boundary = convert_string_to_expected_data_type(tmp_dict[key][-1], expected_data_type,
+ ("upper_boundary_of_" + parameter_name),
+ runtime_output)
+ # Check if value is within specified limits.
+ checked_value = check_boundaries(parameter_name, value, runtime_output, lower_boundary, upper_boundary)
+
+ # Check if the current parameter to check is a multi-parameter with "@ID" xml path.
+ if tmp_dict[key][2]:
+ if not tmp_dict[key][3] in multi_parameter_dict:
+ multi_parameter_dict[tmp_dict[key][3]] = {}
+ multi_parameter_dict[tmp_dict[key][3]][key] = checked_value
+ # Else condition: current parameter is a single parameter.
+ else:
+ # Set value to checked value and write to output dictionary.
+ dict_out_short[key] = checked_value
+ # Else condition: The current expected data type is a tool_level.
+ else:
+ # Check if the value of tool_level is not None.
+ if tmp_dict[key][-3] is not None:
+ dict_out_short[key] = int(tmp_dict[key][-1])
+ # Else condition: The current value of tool_level is None.
+ else:
+ dict_out_short[key] = None
+
+ # Update and append 'dict_out_short'.
+ dict_out_short = {**dict_out_short, **multi_parameter_dict}
+ tmp_list.append(dict_out_short)
+
+ # Extract short versions of dictionaries from 'tmp_list'.
+ short_aircraft_exchange_dict = tmp_list[0]
+ short_module_configuration_dict = tmp_list[1]
+
+ return short_aircraft_exchange_dict, short_module_configuration_dict
+
+
+def get_paths_and_names(module_configuration_file_name, argv):
+ """Generate paths, names, and ElementTree based on module configuration file.
+
+ This function generates paths and names as well as ElementTrees of the module configuration (config) and
+ the associated aircraft exchange file. All generated parameters are returned via the output dictionary
+ 'paths_and_names'.
+
+ The 'paths_and_names' output dictionary contains the following values:
+ - 'working_directory': Current working directory of module (str)
+ - 'parent_directory': Parent directory of module (str)
+ - 'project_directory': Current project directory (str)
+ - 'path_to_module_config_file': Path to module configuration file (str)
+ - 'root_of_module_config_tree': Root of module configuration file tree (ElementTree)
+ - 'path_to_aircraft_exchange_file': Path to aircraft exchange file (str)
+ - 'root_of_aircraft_exchange_tree': Root of aircraft exchange file tree (ElementTree)
+ - 'name_of_project': Name of the current aircraft project (str)
+ - 'tool_name': Name of current tool (str)
+
+ :param str module_configuration_file_name: Name of module configuration file
+ :param list argv: Contains optional input arguments
+ :returns:
+ - dict paths_and_names: Dictionary containing system paths and ElementTrees
+ - logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ """
+
+ # Initialization.
+ path_flag = False
+ given_path = str()
+ log_file_list = []
+ current_parent_directory = str()
+ current_working_directory = str()
+ path_to_module_config_file = str()
+ function_name = getframeinfo(currentframe()).function
+
+ """Generate paths, names, and ElementTree for module configuration file."""
+ # Determine the module's working directory and path to the module configuration file.
+ # This section handles different cases depending on the presence of command line arguments.
+ # Read and process command line arguments.
+ if len(argv) == 1:
+ # Read current working directory.
+ current_working_directory = argv[-1]
+ # Convert path of current working directory to python path (\ to /).
+ current_working_directory = os.path.dirname(current_working_directory.replace(os.sep, '/'))
+ if (len(argv[-1]) >= (len(os.path.splitext(module_configuration_file_name)[0][:-5]))) \
+ and (len(current_working_directory) <= (len(os.path.splitext(module_configuration_file_name)[0][:-5]))):
+ current_working_directory = os.getcwd()
+ # Get current parent directory.
+ count = current_working_directory.rfind('/')
+ current_parent_directory = current_working_directory[0:count]
+ # Generate path of module configuration file.
+ path_to_module_config_file = (current_working_directory + '/' + module_configuration_file_name)
+ else:
+ # Handle a specific command line argument to set the given path.
+ given_path = argv[-1]
+ path_flag = True
+
+ if path_flag:
+ # Convert path of optional argument path of module configuration file to python path (\ to /).
+ if not os.path.isabs(given_path):
+ given_path = os.path.abspath(given_path)
+ current_working_directory = given_path.replace(os.sep, '/')
+ else:
+ given_path = given_path.replace(os.sep, '/')
+ if given_path[-1] == '/':
+ current_working_directory = given_path[:-2]
+ else:
+ current_working_directory = given_path
+ # Check if the optinal path argument is a directory or a file -> if a file -> correct the current_working_directory
+ if not os.path.isdir(current_working_directory):
+ count = current_working_directory.rfind('/')
+ current_working_directory = current_working_directory[:count]
+ # Generate path of module configuration file.
+ path_to_module_config_file = given_path
+ else:
+ # Generate path of module configuration file.
+ path_to_module_config_file = current_working_directory + '/' + module_configuration_file_name
+ # Get current parent directory.
+ count = current_working_directory.rfind('/')
+ current_parent_directory = current_working_directory[:count]
+
+
+ # Determine the current module name 'tool_name' based on the module configuration file name.
+ tool_name = os.path.splitext(module_configuration_file_name)[0][:-5]
+
+ # Read ElementTree of module configuration file.
+ frame_info = getframeinfo(currentframe())
+ # Call function to read module configuration XML file as ElementTree.
+ root_of_module_config_tree, __, log_file_list, error_flag = read_xml_information(
+ path_to_module_config_file, os.path.splitext(module_configuration_file_name)[0], function_name,
+ frame_info.lineno, log_file_list)
+
+ """Generate paths, names, and ElementTree for aircraft exchange file."""
+ if not error_flag:
+ # Read aircraft project name and directory.
+ current_aircraft_exchange_file_name = root_of_module_config_tree.find(
+ "./control_settings/aircraft_exchange_file_name/value").text
+ # Get name of project.
+ name_of_project = os.path.splitext(current_aircraft_exchange_file_name)[0]
+ current_aircraft_exchange_file_directory = root_of_module_config_tree.find("./control_settings/aircraft_exchange_file_directory/value").text
+
+ if not path_flag:
+ # Check if current execution inside of an virtuell enviroment
+ # -> if true: -> rebuild path to aircraft exchange file
+ if sys.prefix != sys.base_prefix:
+ if not os.path.isabs(current_aircraft_exchange_file_directory):
+ current_aircraft_exchange_file_directory = \
+ Path(current_aircraft_exchange_file_directory).resolve().relative_to(Path.cwd().parent)
+ current_aircraft_exchange_file_directory = str(current_parent_directory / current_aircraft_exchange_file_directory)
+
+ else:
+ # Get path to current aircraft project and aircraft exchange file.
+ if not os.path.isabs(current_aircraft_exchange_file_directory):
+ current_aircraft_exchange_file_directory = os.path.abspath(current_aircraft_exchange_file_directory)
+
+ # get absolut path aircraft exchange file
+ path_to_aircraft_exchange_file = current_aircraft_exchange_file_directory + '/' + current_aircraft_exchange_file_name
+ else:
+ name_of_project = os.path.splitext(current_aircraft_exchange_file_name)[0]
+ path_to_aircraft_exchange_file = current_aircraft_exchange_file_directory + '/' \
+ + current_aircraft_exchange_file_name
+
+ # Read ElementTree of module configuration file.
+ frame_info = getframeinfo(currentframe())
+ # Call function to read aircraft exchange XML file as ElementTree.
+ root_of_aircraft_exchange_tree, __, log_file_list, error_flag = read_xml_information(
+ path_to_aircraft_exchange_file, name_of_project, function_name,
+ frame_info.lineno, log_file_list)
+
+ """Generate return dictionary."""
+ paths_and_names = {'working_directory': current_working_directory,
+ 'parent_directory': current_parent_directory,
+ 'project_directory': current_aircraft_exchange_file_directory,
+ 'path_to_module_config_file': path_to_module_config_file,
+ 'root_of_module_config_tree': root_of_module_config_tree,
+ 'path_to_aircraft_exchange_file': path_to_aircraft_exchange_file,
+ 'root_of_aircraft_exchange_tree': root_of_aircraft_exchange_tree,
+ 'name_of_project': name_of_project,
+ 'tool_name': tool_name,
+ }
+ else:
+ paths_and_names = {'working_directory': current_working_directory, 'tool_name': tool_name}
+
+ """Configure logger and initialize logger instance."""
+ configure_runtime_output(paths_and_names)
+ runtime_output = logging.getLogger(__name__)
+
+ if error_flag:
+ for entry in log_file_list:
+ runtime_output.critical(entry)
+ sys.exit(1)
+
+ return paths_and_names, runtime_output
+
+
+def read_xml_information(path, xml_file_name, function_name, code_line, log_file_list):
+ """Read tree of XML file.
+
+ This function reads and returns the ElementTree of the given XML file and its root.
+
+ :param str path: Absolute path to the given XML file
+ :param str xml_file_name: Name of the given XML file to read
+ :param str function_name: Name of the function that called 'read_xml_information'
+ :param int code_line: Code line number of function that called 'read_xml_information' in 1
+ :param list log_file_list: Strings of workflow log file from caller function and added strings from this function
+ :raises OSError: Error if XML file cannot be opened
+ :returns:
+ - ElementTree xml_tree: ElementTree of given XML file
+ - ElementTree root_of_xml_tree: Root of ElementTree of given XML file
+ - list log_file_list: List with log file entries
+ - bool error_flag: Flag if error occurs (error: True, no error: False)
+ """
+
+ # Initialize local parameters.
+ xml_tree = None
+ error_flag = False
+ root_of_xml_tree = None
+ # Initialize element tree with content of file and return root element (if given).
+ try:
+ # Attempt to create an ElementTree and get the root element from the XML file.
+ xml_tree = ET.ElementTree(file=path)
+ root_of_xml_tree = xml_tree.getroot()
+ # Exception handling for operating system (OS) error.
+ except OSError:
+ # Handle an error if the XML file cannot be opened. Print an error message and log it to a log file.
+ log_file_list.append('Error in file "' + function_name + '.py" (line ' + str(code_line + 2) + ') \n'
+ ' ' + 'The "' + xml_file_name +
+ '.xml" file could not be opened. \n'
+ ' ' + 'Program aborted!')
+
+ error_flag = True
+
+ return xml_tree, root_of_xml_tree, log_file_list, error_flag
+
+
+def read_routing_values_from_xml(input_dict, root_of_aircraft_exchange_tree, root_of_module_configuration_tree,
+ runtime_output, module_configuration_tmp_path=None):
+ """Read routing values from XML file.
+
+ This function reads and extracts routing values from an XML file based on the provided input dictionary and
+ ElementTrees.
+
+ The output dictionary 'return_dict' contains the following values:
+ - 'layer_1': First routing layer (str)
+ - 'layer_2': Second routing layer (str)
+ - 'layer_3': Third routing layer (str)
+ - 'user_layer': User layer (own code is implemented on this layer) (str)
+ - 'tool_level': Tool level of current tool (str)
+
+ :param dict input_dict: Input dictionary containing layer descriptions
+ :param ElementTree root_of_aircraft_exchange_tree: Root of aircraft exchange XML
+ :param ElementTree root_of_module_configuration_tree: Root of module configuration XML
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :param string module_configuration_tmp_path: Optional parameter for routing layer paths with ID - defaults to None
+ :raises AttributeError: Error if the "own_tool_level" node does not exist
+ :return dict return_dict: Output dictionary containing layer information
+ """
+
+ # Read lists with n entries from XML file (n equals number of layers).
+ return_dict = input_dict
+ element_exists = True
+ # Iterate over keys from input dict.
+ for key in input_dict:
+ # Check, if 'key' contains information to be read from file.
+ if input_dict[key][0] is not None:
+ # Generate absolute and relative paths to parameter (key).
+ absolute_path_to_parameter = input_dict[key][0]
+ relative_path_to_parameter = './' + absolute_path_to_parameter.split('/', 1)[1]
+ # Extract first part of path string (equals file type: 'aircraft_exchange_file' or
+ # 'module_configuration_file').
+ file_type = absolute_path_to_parameter.split('/')[0]
+ if file_type == 'aircraft_exchange_file':
+ root_of_tree = root_of_aircraft_exchange_tree
+ else:
+ root_of_tree = root_of_module_configuration_tree
+ # Check if element (path) exists.
+ tmp = root_of_tree.findall(relative_path_to_parameter)
+ if tmp is None:
+ element_exists = False
+ # Set value of parameter if element given.
+ if element_exists:
+ # Only on element of layer value exist -> no ID element in the path for the routing layer node.
+ if len(tmp) == 1:
+ return_dict[key] = tmp[0].text
+ # At least 2 elements with the same routing layer exist -> ID element in the path for the routing layer.
+ # Check if the optional parameter "module_configuration_tmp_path" is not None
+ # -> if true: -> prepare relative path to routing layer node with ID from routing layer 1.
+ elif module_configuration_tmp_path is not None:
+ if module_configuration_tmp_path[-1] == '/':
+ module_configuration_tmp_path = module_configuration_tmp_path[:-1]
+ module_configuration_tmp_path = './' + module_configuration_tmp_path.split('/', 1)[1]
+ relative_path_to_parameter = relative_path_to_parameter.split(module_configuration_tmp_path)[-1]
+ id_path = module_configuration_tmp_path + '[@ID="' + next(iter(return_dict.values())) + '"]/' \
+ + relative_path_to_parameter
+ return_dict[key] = root_of_tree.find(id_path).text
+ # At least 2 elements with the same routing layer exist but no optional paramter is given
+ # -> raise an error and abort program.
+ else:
+ runtime_output.critical('Error: At least there are two possible parameter nodes for the routing layer. \n' #noPep8 e501
+ ' Please call the function "read_routing_values_from_xml" with the optional parameter as described in "datapreprocessing.py".\n'
+ ' Program abortet!')
+ sys.exit(1)
+
+ # Set value of parameter to 'None' if not given.
+ else:
+ return_dict[key] = None
+ # If 'key' is None, write 'None' into 'return_dict'.
+ else:
+ return_dict[key] = None
+
+ # Add tool level to return dictionary.
+ try:
+ return_dict['tool_level'] = root_of_module_configuration_tree.find('./control_settings/own_tool_level/value').text
+ except AttributeError as e:
+ # Attach both handlers to the root logger
+ runtime_output.critical('Error: ' + str(e) + ' \n'
+ + ' '
+ + 'Node "own_tool_level" not found in module configuration file. \n'
+ + ' ' + 'Program aborted!')
+ sys.exit(1)
+
+ return return_dict
+
+
+def read_values_from_xml_file(input_dict, root_of_xml_file, runtime_output):
+ """Read values from XML file.
+
+ This function extracts specific values from a XML file, including the parameter's value, lower boundary, and upper
+ boundary, based on the information provided in the 'input_dict'. It processes the XML structure of the file and
+ constructs an output dictionary with the extracted values.
+
+ The data of the output dictionary 'return_dict' are structured according to the following scheme:
+ return_dict = {'parameter_name_1': [path, expected data type, bool for parameter with ID, parameter name,
+ value, lower boundary, upper boundary],
+ 'parameter_name_2': [...],
+ ...}
+
+ :param dict input_dict: Input dictionary with information on values to read from XML file
+ :param ElementTree root_of_xml_file: Root of XML tree
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :raises ValueError: Raised if parameter does not exist in node
+ :return dict return_dict: Dictionary containing parameter from XML file
+ """
+
+ # Initialization.
+ id_tag = str()
+ cleaned_string = str()
+ key_list_to_delete = []
+ return_dict = input_dict
+ parameter_list = ['value', 'lower_boundary', 'upper_boundary']
+ file_type = root_of_xml_file._root.tag.replace('_', ' ')
+ # Extraction of values from the XML file.
+ try:
+ # Iterate over every parameter in 'input_dict'.
+ for key in input_dict:
+ tmp_dict = {}
+ # Find corresponding node in 'root_of_xml_file'.
+ if '[@ID="0"]' in input_dict[key][0] or '[@id="0"]' in input_dict[key][0] \
+ or '[@UID="0"]' in input_dict[key][0] or '[@uid="0"]' in input_dict[key][0]:
+ if '[@ID="0"]' in input_dict[key][0]:
+ cleaned_string = re.sub(r'\[@ID="0"\]', '', input_dict[key][0])
+ id_count = len(re.findall(r'\[@ID="0"\]', input_dict[key][0]))
+ id_tag = '@ID="0"'
+ id_naming = '@ID='
+ elif '[@id="0"]' in input_dict[key][0]:
+ cleaned_string = re.sub(r'\[@id="0"\]', '', input_dict[key][0])
+ id_count = len(re.findall(r'\[@id="0"\]', input_dict[key][0]))
+ id_tag = '@id="0"'
+ id_naming = '@id='
+ elif '[@UID="0"]' in input_dict[key][0]:
+ cleaned_string = re.sub(r'\[@UID="0"\]', '', input_dict[key][0])
+ id_count = len(re.findall(r'\[@UID="0"\]', input_dict[key][0]))
+ id_tag = '@UID="0"'
+ id_naming = '@UID='
+ elif '[@uid="0"]' in input_dict[key][0]:
+ cleaned_string = re.sub(r'\[@uid="0"\]', '', input_dict[key][0])
+ id_count = len(re.findall(r'\[@uid="0"\]', input_dict[key][0]))
+ id_tag = '@uid="0"'
+ id_naming = '@uid='
+
+ # Extract the number of existing end nodes in the aircraft exchange file of current parameter.
+ key_id_list = root_of_xml_file.findall(cleaned_string)
+
+ # Check if at least one end node is existing.
+ # -> if true: -> generate all xml paths to the existing end nodes
+ key_list_to_delete.append(key)
+ if len(key_id_list) > 0:
+ indexes_of_ids = []
+ index = input_dict[key][0].find(id_tag)
+ # Loop through the entire input xml path to get ID identifier indexes.
+ while index != -1:
+ indexes_of_ids.append(index)
+ index = input_dict[key][0].find(id_tag, index + 1)
+ indexes_of_ids = [x - 1 for x in indexes_of_ids]
+
+ string_part_list = []
+ test_string_list = []
+ # Loop across the number of indexes to split the input xml path in separate parts.
+ i = []
+ for i in range(0, len(indexes_of_ids)):
+ string_part = cleaned_string[:indexes_of_ids[i] - i * (len(id_tag) + 2)]
+ if i == 0:
+ string_part_list.append(input_dict[key][0][:(indexes_of_ids[i] + len(id_tag) + 2)])
+ else:
+ string_part_list.append(
+ input_dict[key][0][indexes_of_ids[i-1] + (len(id_tag) + 2):indexes_of_ids[i]
+ + (len(id_tag) + 2)])
+ tmp_list = [string_part, len(root_of_xml_file.findall(string_part))]
+ test_string_list.append(tmp_list)
+
+ # Add the xml path part behind the last ID identifier to string part list.
+ string_part_list.append(input_dict[key][0][(indexes_of_ids[i] + len(id_tag) + 2):])
+
+ # Generate ID list of one single parent node with all possible child nodes to target parameter.
+ number_of_fist_elements = test_string_list[0][1]
+ id_list = [int(test_string_list[0][1] / number_of_fist_elements) - 1]
+ for j in range(1, len(test_string_list)):
+ id_list.append(int(test_string_list[j][1] / test_string_list[j-1][1]) - 1)
+
+ # Loop across all possible nodes to generate all xml-paths to the end node of current parameter.
+ loop_count = 0
+ parameter_path_list = []
+ for i in range(len(id_list)-1, -1, -1):
+ dummy_list = []
+ # Check if current loop is the first -> if true: -> generate initial xml path elements.
+ if i == len(id_list)-1:
+ # Initialize all possible end node IDs of current parameter for the ID="0" parent root.
+ for j in range(0, id_list[i] + 1):
+ part_with_id =(
+ string_part_list[i][:string_part_list[i].find(id_tag)
+ + len(id_naming)] + '"' + str(j) + '"]')
+ dummy_list.append(part_with_id + string_part_list[i+1])
+ else:
+ for j in range(0, id_list[i] + 1):
+ part_with_id =(
+ string_part_list[i][:string_part_list[i].find(id_tag)
+ + len(id_naming)] + '"' + str(j) + '"]')
+ for k in range(0, len(parameter_path_list[loop_count-1])):
+ dummy_list.append(part_with_id + parameter_path_list[loop_count-1][k])
+
+ parameter_path_list.append(dummy_list)
+ loop_count += 1
+
+ # Convert final parameter path lists of list to on final paths list.
+ if isinstance(parameter_path_list, list):
+ parameter_path_list = parameter_path_list[-1]
+ else:
+ parameter_path_list = [parameter_path_list]
+
+ # Check if more than one parent root node of parameter exists.
+ # -> if true: -> add all remaining xml paths to parameter path list
+ if number_of_fist_elements > 1:
+ first_part = parameter_path_list[0][:(indexes_of_ids[0] + len(id_naming) + 1)]
+ for i in range(1, number_of_fist_elements):
+ for j in range(0, len(parameter_path_list)):
+ parameter_path_list.append(first_part + '"' + str(i) + '"' + parameter_path_list[j][(indexes_of_ids[0] + len(id_tag) + 1):]) # noPep8 e501
+
+ # Generate temporary dictionary with names, xml paths and expected data type.
+ for i in range(0, len(parameter_path_list)):
+ numerical_values = re.findall(r'@ID="(\d+)"', parameter_path_list[i])
+ numerical_string = ['_ID' + str(value) for value in numerical_values]
+ numerical_string = key + ''.join(numerical_string)
+ tmp_dict[numerical_string] = [parameter_path_list[i], input_dict[key][1], True, key]
+
+ # Else condition: no one end node of current key is existing in the aircraft exchange file.
+ else:
+ numerical_values = re.findall(r'@ID="(\d+)"', input_dict[key][0])
+ numerical_string = ['_ID' + str(value) for value in numerical_values]
+ numerical_string = key + ''.join(numerical_string)
+ tmp_dict[numerical_string] = [input_dict[key][0], input_dict[key][1], True, key]
+
+ # Else condition: The string of the xml path of current key, contains no ID identifier.
+ else:
+ tmp_dict[key] = [input_dict[key][0], input_dict[key][1], False, key]
+
+ # Update return dict.
+ return_dict = {**return_dict, **tmp_dict}
+ # Loop across all temporary key elements to read the responding values from the element tree.
+ for tmp_key, value in tmp_dict.items():
+ # Try to find temporary element from xml-tree.
+ tmp = root_of_xml_file.find(tmp_dict[tmp_key][0])
+
+ # Initialize 'value', 'lower_boundary', and 'upper_boundary' of value with 'None' if node does not exist
+ if tmp is None or tmp_dict[tmp_key][1] is None:
+ if tmp_dict[tmp_key][2]:
+ return_dict[tmp_key] = [tmp_dict[tmp_key][0], tmp_dict[tmp_key][1], True, tmp_dict[tmp_key][3],
+ None, None, None]
+ else:
+ return_dict[tmp_key] = [tmp_dict[tmp_key][0], tmp_dict[tmp_key][1], False, tmp_dict[tmp_key][3],
+ None, None, None]
+ runtime_output.info('Attention: Node "' + tmp_dict[tmp_key][0] + '" not found in ' + file_type
+ + '. Value, lower, and upper boundary initialized with "None".')
+ if not tmp is None and tmp_dict[tmp_key][1] is None:
+ return_dict[tmp_key][1] = bool
+ return_dict[tmp_key][4] = 'True'
+ elif tmp_dict[tmp_key][1] is None:
+ return_dict[tmp_key][1] = bool
+ return_dict[tmp_key][4] = 'False'
+ elif tmp_dict[tmp_key][1] == 'tool_level':
+ tmp_parameter = root_of_xml_file.find(tmp_dict[tmp_key][0])
+ if tmp_parameter is not None:
+ return_dict[tmp_key] += [tmp_parameter.attrib['tool_level']]
+ else:
+ # Check existence of every parameter in 'parameter_list' and append text if given and 'None' if not.
+ for parameter in parameter_list:
+ parameter_exists = True
+ # Append parameter to path and check existence.
+ tmp_parameter = root_of_xml_file.find(tmp_dict[tmp_key][0] + '/' + parameter)
+ # Raise error if parameter 'value' does not exist in current node.
+ if parameter == 'value' and tmp_parameter is None:
+ parameter_exists = False
+ raise ValueError('Node "' + tmp_dict[tmp_key][0] + '/' + parameter + '" not found in '
+ + file_type + '. Program aborted!')
+ # Set 'parameter_exists' to 'False' if 'lower_boundary' or 'upper_boundary' missing, print warning.
+ elif tmp_parameter is None:
+ parameter_exists = False
+ runtime_output.info('Attention: Node "' + tmp_dict[tmp_key][0] + '/' + parameter
+ + '" not found in ' + file_type + '.')
+ # Append parameter text if existing (equals value of parameter).
+ if parameter_exists:
+ return_dict[tmp_key] += [tmp_parameter.text]
+ # Append 'None' to 'return_dict' if parameter does not exist, print a warning.
+ else:
+ return_dict[tmp_key] += [None]
+ runtime_output.info('Attention: No "' + parameter + '" defined for "' + tmp_key
+ + '". Set to "None" instead.')
+
+ for key in key_list_to_delete:
+ del return_dict[key]
+
+ # Exception handling for ValueError.
+ except ValueError as e:
+ runtime_output.critical('Error:' + str(e))
+ sys.exit(1)
+
+ return return_dict
+
+
+def convert_string_to_expected_data_type(input_value, expected_data_type, variable_name, runtime_output):
+ """This function converts a string to a desired data type.
+
+ This function converts an input string to the given data type (if valid). Valid data types are
+ - int (integer),
+ - float,
+ - str (string), and
+ - bool.
+ The function enforces two conditions for a successful conversion:
+ 1) Valid expected data type: If the data type is invalid, the function returns 'None' for the return value and
+ raises an error.
+ 2) The input value must not be 'None': This is particularly important when converting the limit values, as they
+ may not exist and thus be read out as 'None' from the configuration file.
+ If a value is convertible, the conversion is executed in dependence of the data type. If conversion is not
+ possible, a ValueError is raised.
+
+ :param str input_value: Input value
+ :param <class 'type'> expected_data_type: Expected data type
+ :param str variable_name: Name of the input variable
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :raises ValueError: Error if value cannot be converted to expected data type
+ :return int/float/str/bool converted_value: Input value converted to expected data type
+ """
+
+ # Initialize output parameter (only changed if valid conversion possible).
+ converted_value = None
+ # Define expected data type and check if it is valid.
+ expected_class_int = str(expected_data_type) == "<class 'int'>"
+ expected_class_float = str(expected_data_type) == "<class 'float'>"
+ expected_class_str = str(expected_data_type) == "<class 'str'>"
+ expected_class_bool = str(expected_data_type) == "<class 'bool'>"
+ valid_expected_data_type = (
+ expected_class_int or expected_class_float or expected_class_str or expected_class_bool)
+ # If 'bool' expected, the following inputs are accepted as true/false.
+ dict_bool_true = {'True': True, 'true': True, '1': True, '1.0': True}
+ dict_bool_false = {'False': False, 'false': False, '0': False, '0.0': False}
+
+ # Check if input value is of class 'NoneType'.
+ input_of_class_none_type = (input_value is None) or (input_value == 'None')
+
+ # If valid data type and value is not 'None'.
+ if valid_expected_data_type and not input_of_class_none_type:
+ # If expected data type is of "<class 'int'>".
+ if expected_class_int:
+ # Check if value is of type 'int' (could subsequently be converted to 'int').
+ try:
+ converted_value = expected_data_type(input_value)
+ # Otherwise value is not of type 'int'.
+ except ValueError:
+ # Check if value is of type 'float' (could subsequently be converted to 'float' and 'int').
+ try:
+ converted_value = expected_data_type(float(input_value))
+ runtime_output.info("Attention: Expected data type was 'int' but input value was of type 'float'."
+ "The value was first converted to a float value and then to an int."
+ "Decimal places are lost in the process.")
+ # Value error (value not of type 'int' or 'float').
+ except ValueError:
+ runtime_output.info(
+ ("Attention: Expected data type was 'int' but input value was neither of type 'int' "
+ "nor 'float'. Value conversion not possible for parameter '" + variable_name + "'."))
+ # If expected data type is of "<class 'float'>".
+ if expected_class_float:
+ # Check if value can be converted to 'float' (means value is of type 'int' or 'float').
+ try:
+ converted_value = expected_data_type(input_value)
+ # Handle exception if value is not of type 'int' or 'float'.
+ except ValueError:
+ runtime_output.info(
+ ("Attention: Expected data type was 'float', but the input value seems to be of type string "
+ "or bool. Value conversion not possible for parameter '" + variable_name + "'."))
+ # If expected data type is of "<class 'str'>".
+ if expected_class_str:
+ converted_value = input_value
+ # If expected data type is of "<class 'bool'>".
+ if expected_class_bool:
+ # Check if input is a valid expression for 'True'.
+ if dict_bool_true.get(input_value):
+ converted_value = True
+ # Check if input is a valid expression for 'False'.
+ elif dict_bool_false.get(input_value):
+ converted_value = False
+ # Input does not contain a valid expression for boolean values.
+ else:
+ runtime_output.info(
+ ("Attention: Expected data type was 'bool', "
+ "but input does not seems to contain valid expressions for boolean values."
+ "Value conversion not possible for parameter '" + variable_name + "'."))
+ # No valid data type or value is 'None' (often the case if no default values provided in configuration file).
+ else:
+ runtime_output.info("Attention: Invalid data type or input value is 'None' (" + variable_name + ").")
+
+ return converted_value
+
+
+def check_boundaries(parameter_name, input_value, runtime_output, lower_boundary=None, upper_boundary=None):
+ """Verify that a value is within specified limits.
+
+ This function checks whether a given input value falls within specified boundaries (lower and upper limits). It is
+ designed to handle values of different data types, including int, float, str, and bool. It raises errors or
+ warnings when the input does not meet the expected criteria.
+
+ :param str parameter_name: Name of the parameter
+ :param int/float/str/bool input_value: Value of the parameter
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :param int/float/str/bool lower_boundary: Lower boundary (parameter value must be greater), defaults to None
+ :param int/float/str/bool upper_boundary: Upper boundary (parameter value must be smaller), defaults to None
+ :raises ValueError: Error if parameter value is outside the specified boundaries
+ :return int/float/str/bool checked_value: Checked input value
+ """
+
+ # Initialize local parameter.
+ checked_value = input_value
+
+ # Check if boundary check possible (Value of type 'int'/'float'?).
+ if isinstance(input_value, bool):
+ boundary_check_possible = False
+ else:
+ boundary_check_possible = isinstance(input_value, (int, float))
+ # Check if boundaries are given.
+ boundaries_given = (lower_boundary is not None and upper_boundary is not None)
+
+ # Perform boundary checks.
+ try:
+ # If value is of data type that allows boundary check.
+ if boundary_check_possible:
+ # If both boundaries are given.
+ if boundaries_given:
+ # Check if given input value lower than given lower boundary. Raise error if true.
+ if input_value < lower_boundary:
+ user_value_error_string = ('The parameter "' + parameter_name
+ + '" is lower than the expected lower boundary ('
+ + str(lower_boundary) + '). Program aborted!')
+ raise ValueError(user_value_error_string)
+ # Check if given input value higher than given upper boundary. Raise error if true.
+ elif input_value > upper_boundary:
+ user_value_error_string = ('The parameter "' + parameter_name
+ + '" is higher than the expected upper boundary ('
+ + str(upper_boundary) + '). Program aborted!')
+ raise ValueError(user_value_error_string)
+ # Raise error if no boundaries given but required.
+ else:
+ user_value_error_string = ('The data type "' + str(type(input_value))
+ + ') of the given input parameter "' + parameter_name
+ + '" requires lower and upper boundaries. Program aborted!')
+ raise ValueError(user_value_error_string)
+ # Input value is not of a valid data type for boundary checking.
+ else:
+ runtime_output.info(
+ ('Attention: The data type of the given input parameter "' + parameter_name +
+ '" (' + str(type(input_value)) +
+ ') is not of type int or float. Therefore no boundaries were checked.'))
+ # Exception handling if values outside the limits or no boundaries given.
+ except ValueError as e:
+ runtime_output.critical('Error: ' + str(e))
+ sys.exit(1)
+
+ return checked_value
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/runmodule.py b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/runmodule.py
new file mode 100644
index 0000000..fc23a69
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/runmodule.py
@@ -0,0 +1,54 @@
+"""Module providing run function of calculation method."""
+# Import standard modules.
+import sys
+import importlib
+from datapreprocessingmodule import method_data_preprocessing
+
+
+def run_module(paths_and_names, routing_dict, runtime_output):
+ """Conduct Python module.
+
+ This function performs any UNICADO Python module. The process involves the following steps:
+ (1) Method-specific preprocessing: The prerequisite for any UNICADO Python module is the acquisition of data
+ from corresponding exchange files. These include the aircraft exchange and the module configuration file. This
+ data preprocessing is crucial as it prepares the input data for the calculation method. The obtained data are
+ stored in the two dictionaries 'aircraft_exchange_dict' and 'module_configuration_dict'.
+ (2) Run calculation method: Depending on the user layer specified in the routing parameters, the function calls
+ the appropriate calculation function. The selected function is dynamically imported and executed.
+ The output dictionary 'run_output_dict' contains the result of the UNICADO Python module and is structured according
+ to the following scheme:
+ run_output_dict = {'parameter_name_1': value, ...}
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :param dict routing_dict: Dictionary containing routing parameters
+ :param logging.Logger runtime_output: Logging object used for capturing log messages in the module
+ :raises ModuleNotFoundError: Raised if module cannot be imported
+ :return dict run_output_dict: Dictionary containing results of module execution
+ """
+
+ """Method specific preprocessing: Acquire necessary data."""
+ # Run 'method_data_preprocessing' from 'datapreprocessingmodule'.
+ aircraft_exchange_dict, module_configuration_dict = method_data_preprocessing(paths_and_names, routing_dict, runtime_output)
+
+ """Run: Execute code depending on user layer."""
+ # Prepare strings for dynamic imports of calculation functions. The 'import_command_method_user_layer' is build
+ # according to the following scheme:
+ # 'src.[value of layer_1].[value of layer_2].[value of layer_3].[value of user layer].method[value of user layer]'
+ # The 'function_name' is generated according to the following scheme:
+ # 'method_[value of user layer]'
+ import_command_method_user_layer = (routing_dict['module_import_name'] + '.' + routing_dict['user_layer']
+ + '.method' + routing_dict['user_layer'].replace('_', ''))
+ function_name = 'method_' + routing_dict['user_layer']
+ # Import calculation module.
+ try:
+ module = importlib.import_module(import_command_method_user_layer)
+ # Call function depending on routing parameters.
+ run_output_dict = getattr(module, function_name)(paths_and_names, routing_dict, aircraft_exchange_dict,
+ module_configuration_dict, runtime_output)
+ # Exception handling for module import error.
+ except ModuleNotFoundError as module_import_error:
+ runtime_output.critical('Error: ' + str(module_import_error) + ' found in ' + routing_dict['module_name'] + '\n'
+ + ' ' + 'Program aborted!')
+ sys.exit(1)
+
+ return run_output_dict
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/runtimeoutputmodule.py b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/runtimeoutputmodule.py
new file mode 100644
index 0000000..f8806ec
--- /dev/null
+++ b/docs/get-involved/modularization/python-template/AircraftDesign/unicado_python_library/pymodulepackage/src/runtimeoutputmodule.py
@@ -0,0 +1,123 @@
+"""Module configuring the runtime output."""
+# Import standard modules.
+import sys
+import logging
+
+
+def configure_runtime_output(paths_and_names):
+ """ Initialize logging handler for console prints and log file writing, provide runtime_output instance.
+
+ [Add some text here...]
+
+ :param dict paths_and_names: Dictionary containing system paths and ElementTrees
+ :raises AttributeError: ...
+ :return:
+ """
+ # Define a new log level 'PRINT' with a value of 35.
+ PRINT = 35
+ logging.addLevelName(PRINT, "PRINT")
+
+ # Create a custom log level class by subclassing logging.Filter.
+ class PrintoutFilter(logging.Filter):
+ def filter(self, record):
+ return record.levelno == PRINT
+
+ # Attach the custom filter to the 'root_logger'.
+ root_logger = logging.getLogger()
+ root_logger.addFilter(PrintoutFilter())
+
+ # Add a custom method to the logger.
+ def printout(self, message, *args, **kwargs):
+ """
+ :param self:
+ :param message:
+ :param args:
+ :param kwargs:
+ :return:
+ """
+ if self.isEnabledFor(PRINT):
+ self._log(PRINT, message, args, **kwargs)
+
+ # Attach the custom method to the logger.
+ logging.Logger.print = printout
+
+ # Set the logging level for the root logger.
+ root_logger.setLevel(logging.DEBUG)
+
+ """Genereate log file handler and initialze."""
+ # Create a file handler with the desired file name and format.
+ log_file_name = paths_and_names['working_directory'] + '/' + paths_and_names['tool_name'] + '.log'
+ log_format = '%(asctime)s - %(levelname)s - %(message)s'
+ file_handler = logging.FileHandler(log_file_name)
+ file_handler.setFormatter(logging.Formatter(log_format))
+
+ """Genereate console handler and initialze."""
+ # Create a stream handler to output log messages to the console.
+ console_format = '%(asctime)s - %(levelname)s - %(message)s'
+ console_handler = logging.StreamHandler()
+ console_handler.setFormatter(logging.Formatter(console_format))
+
+ """Set log file handler level to selected mode from module configuration file."""
+ # Extract 'log_file_output' from 'root_of_module_config_tree'.
+ try:
+ log_file_mode = paths_and_names['root_of_module_config_tree'].find('.//log_file_output/value').text
+ except AttributeError as e:
+ # Attach both handlers to the 'root_logger'.
+ root_logger.addHandler(file_handler)
+ root_logger.addHandler(console_handler)
+ logger = logging.getLogger('module_logger')
+ logger.critical('Error: ' + str(e) + ' \n'
+ + ' '
+ + 'Node "log_file_output" not found in module configuration file. \n'
+ + ' ' + 'Program aborted!')
+ sys.exit(1)
+
+ match log_file_mode:
+ # Only 'CRITICAL' logs displayed.
+ case 'mode_0':
+ file_handler.setLevel(logging.CRITICAL)
+ # Logs of type 'CRITICAL', 'ERROR', 'PRINTOUT', and 'WARNING' displayed.
+ case 'mode_1':
+ file_handler.setLevel(logging.WARNING)
+ # Logs of type 'CRITICAL', 'ERROR', 'PRINTOUT', 'WARNING', and 'INFO' displayed.
+ case 'mode_2':
+ file_handler.setLevel(logging.INFO)
+ # Logs of type 'CRITICAL', 'ERROR', 'PRINTOUT', 'WARNING', 'INFO', and 'DEBUG' displayed.
+ case 'mode_3':
+ file_handler.setLevel(logging.DEBUG)
+
+ """Set console handler level to selected mode from module configuration file."""
+ # Extract 'console_output' from 'root_of_module_config_tree'.
+ try:
+ console_output = paths_and_names['root_of_module_config_tree'].find('.//console_output/value').text
+ except AttributeError as e:
+ # Attach both handlers to the 'root_logger'.
+ root_logger.addHandler(file_handler)
+ root_logger.addHandler(console_handler)
+ logger = logging.getLogger('module_logger')
+ logger.critical('Error: ' + str(e) + ' \n'
+ + ' '
+ + 'Node "console_output" not found in module configuration file. \n'
+ + ' ' + 'Program aborted!')
+ sys.exit(1)
+
+ match console_output:
+ # Only 'CRITICAL' logs displayed.
+ case 'mode_0':
+ console_handler.setLevel(logging.CRITICAL)
+ # Logs of type 'CRITICAL', 'ERROR', 'PRINTOUT', and 'WARNING' displayed.
+ case 'mode_1':
+ console_handler.setLevel(logging.WARNING)
+ # Logs of type 'CRITICAL', 'ERROR', 'PRINTOUT', 'WARNING', and 'INFO' displayed.
+ case 'mode_2':
+ console_handler.setLevel(logging.INFO)
+ # Logs of type 'CRITICAL', 'ERROR', 'PRINTOUT', 'WARNING', 'INFO', and 'DEBUG' displayed.
+ case 'mode_3':
+ console_handler.setLevel(logging.DEBUG)
+
+ # Disable colorization for the console handler.
+ console_handler.setStream(stream=sys.stdout)
+
+ # Attach both handlers to the 'root_logger'.
+ root_logger.addHandler(file_handler)
+ root_logger.addHandler(console_handler)
--
GitLab
From 3a0c67b84bb630e45a6be012850a28865daff341 Mon Sep 17 00:00:00 2001
From: sroscher <s.roscher@tu-berlin.de>
Date: Thu, 6 Feb 2025 13:55:24 +0100
Subject: [PATCH 2/2] - Deleted the icons - Deleted log file - Deleted pycache
files - Deleted doc folder - Renamed `main.py` to `cost_estimation.py`
---
.../AircraftDesign/cost_estimation/Icon\r" | 0
.../cost_estimation/cost_estimation.log | 117 -
.../{main.py => cost_estimation.py} | 0
.../cost_estimation/doc/Doxyfile | 2824 -----------------
.../cost_estimation/doc/DoxygenLayout.xml | 242 --
.../doc/content/getting_started.md | 339 --
.../cost_estimation/doc/content/index.md | 16 -
.../doc/content/operating_cost_method.md | 3 -
.../doc/content/software_architecture.md | 2 -
.../cost_estimation/doc/header.html | 86 -
.../cost_estimation/src/Icon\r" | 0
.../src/blended_wing_body/Icon\r" | 0
.../cost_estimation/src/tube_and_wing/Icon\r" | 0
.../src/tube_and_wing/empirical/Icon\r" | 0
.../Icon\r" | 0
.../general/Icon\r" | 0
.../kerosene/Icon\r" | 0
.../methodkerosene.cpython-311.pyc | Bin 2179 -> 0 bytes
.../liquid_hydrogen/Icon\r" | 0
19 files changed, 3629 deletions(-)
delete mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/Icon\r"
delete mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation.log
rename docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/{main.py => cost_estimation.py} (100%)
delete mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/Doxyfile
delete mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/DoxygenLayout.xml
delete mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/getting_started.md
delete mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/index.md
delete mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/operating_cost_method.md
delete mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/software_architecture.md
delete mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/header.html
delete mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/Icon\r"
delete mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/blended_wing_body/Icon\r"
delete mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/Icon\r"
delete mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/Icon\r"
delete mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/Icon\r"
delete mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/Icon\r"
delete mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/Icon\r"
delete mode 100644 docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/__pycache__/methodkerosene.cpython-311.pyc
delete mode 100644 "docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/liquid_hydrogen/Icon\r"
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/Icon\r"
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation.log b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation.log
deleted file mode 100644
index 7699eab..0000000
--- a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation.log
+++ /dev/null
@@ -1,117 +0,0 @@
-2024-02-13 09:04:07,608 - PRINT - Operating cost estimation started...
-2024-02-13 09:04:07,652 - PRINT - ----------------------------------------------------------
-2024-02-13 09:04:07,653 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-02-13 09:04:07,653 - PRINT - ----------------------------------------------------------
-2024-02-13 09:04:07,702 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
-2024-02-13 09:04:07,702 - PRINT - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
-2024-02-13 09:04:07,709 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
-2024-02-13 09:04:07,710 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
-2024-02-13 09:04:07,710 - PRINT - Operating cost estimation finished.
-2024-02-13 09:12:29,973 - PRINT - Operating cost estimation started...
-2024-02-13 09:12:30,029 - PRINT - ----------------------------------------------------------
-2024-02-13 09:12:30,029 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-02-13 09:12:30,029 - PRINT - ----------------------------------------------------------
-2024-02-13 09:12:30,076 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
-2024-02-13 09:12:30,077 - PRINT - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
-2024-02-13 09:12:30,084 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
-2024-02-13 09:12:30,088 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
-2024-02-13 09:12:30,089 - PRINT - Operating cost estimation finished.
-2024-02-13 09:56:53,711 - PRINT - Operating cost estimation started...
-2024-02-13 09:56:53,731 - PRINT - ----------------------------------------------------------
-2024-02-13 09:56:53,732 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-02-13 09:56:53,732 - PRINT - ----------------------------------------------------------
-2024-02-13 09:56:53,755 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
-2024-02-13 09:56:53,755 - PRINT - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
-2024-02-13 09:56:53,758 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
-2024-02-13 09:56:53,759 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
-2024-02-13 09:56:53,759 - PRINT - Operating cost estimation finished.
-2024-02-13 10:21:47,825 - PRINT - Operating cost estimation started...
-2024-02-13 10:21:47,839 - PRINT - ----------------------------------------------------------
-2024-02-13 10:21:47,839 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-02-13 10:21:47,839 - PRINT - ----------------------------------------------------------
-2024-02-13 10:21:47,862 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
-2024-02-13 10:21:47,862 - PRINT - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
-2024-02-13 10:21:47,865 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
-2024-02-13 10:21:47,866 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
-2024-02-13 10:21:47,866 - PRINT - Operating cost estimation finished.
-2024-02-13 10:51:25,723 - PRINT - Operating cost estimation started...
-2024-02-13 10:51:25,737 - PRINT - ----------------------------------------------------------
-2024-02-13 10:51:25,738 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-02-13 10:51:25,738 - PRINT - ----------------------------------------------------------
-2024-02-13 10:51:25,760 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
-2024-02-13 10:51:25,761 - PRINT - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
-2024-02-13 10:51:25,763 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
-2024-02-13 10:51:25,764 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
-2024-02-13 10:51:25,764 - PRINT - Operating cost estimation finished.
-2024-06-19 10:13:51,184 - PRINT - Operating cost estimation started...
-2024-06-19 10:13:51,188 - PRINT - ----------------------------------------------------------
-2024-06-19 10:13:51,189 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-06-19 10:13:51,189 - PRINT - ----------------------------------------------------------
-2024-06-19 10:13:51,194 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
-2024-06-19 10:13:51,194 - WARNING - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
-2024-06-19 10:13:51,196 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
-2024-06-19 10:13:51,196 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
-2024-06-19 10:13:51,196 - PRINT - Operating cost estimation finished.
-2024-06-19 10:15:37,122 - PRINT - Operating cost estimation started...
-2024-06-19 10:15:37,125 - PRINT - ----------------------------------------------------------
-2024-06-19 10:15:37,125 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-06-19 10:15:37,126 - PRINT - ----------------------------------------------------------
-2024-06-19 10:15:37,126 - CRITICAL - KeyError: 'operating_cost_estimation_tu_berlin'
- Main execution of cost estimation module failed!
- Program aborted.
-2024-06-19 10:32:57,451 - PRINT - Operating cost estimation started...
-2024-06-19 10:32:57,455 - PRINT - ----------------------------------------------------------
-2024-06-19 10:32:57,455 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-06-19 10:32:57,455 - PRINT - ----------------------------------------------------------
-2024-06-19 10:32:57,455 - CRITICAL - TypeError: prepare_element_tree_for_module_key_parameter() takes 2 positional arguments but 3 were given
- Main execution of cost estimation module failed!
- Program aborted.
-2024-06-19 10:39:01,575 - PRINT - Operating cost estimation started...
-2024-06-19 10:39:01,579 - PRINT - ----------------------------------------------------------
-2024-06-19 10:39:01,579 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-06-19 10:39:01,579 - PRINT - ----------------------------------------------------------
-2024-06-19 10:39:01,585 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
-2024-06-19 10:39:01,585 - WARNING - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
-2024-06-19 10:39:01,587 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
-2024-06-19 10:39:01,587 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
-2024-06-19 10:39:01,587 - PRINT - Operating cost estimation finished.
-2024-06-19 10:41:59,058 - PRINT - Operating cost estimation started...
-2024-06-19 10:43:24,962 - PRINT - Operating cost estimation started...
-2024-06-19 10:43:24,968 - PRINT - ----------------------------------------------------------
-2024-06-19 10:43:24,968 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-06-19 10:43:24,968 - PRINT - ----------------------------------------------------------
-2024-06-19 10:43:24,974 - WARNING - Warning: "plot_output" switch in module configuration file set to "False". No plots generated.
-2024-06-19 10:43:24,974 - WARNING - Warning: No "method_html_report" function in "methodhtmlreport.py" file implemented yet.
-2024-06-19 10:43:24,975 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
-2024-06-19 10:43:24,976 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
-2024-06-19 10:43:24,976 - PRINT - Operating cost estimation finished.
-2024-11-18 10:46:15,464 - PRINT - Cost estimation started...
-2024-11-18 10:46:15,467 - PRINT - ----------------------------------------------------------
-2024-11-18 10:46:15,468 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-11-18 10:46:15,468 - PRINT - ----------------------------------------------------------
-2024-11-18 10:46:15,473 - CRITICAL - AttributeError:
- - File : datapostprocessingmodule.py
- - Function / Method: method_data_postprocessing
- - Line : 740
- - Code : html_switch = eval(root_of_module_config_tree.find('.//report_output/value').text.capitalize())
- - Error message : 'NoneType' object has no attribute 'text'
-Main execution of cost estimation module failed!
-Program aborted.
-2024-11-18 10:47:45,414 - PRINT - Cost estimation started...
-2024-11-18 10:47:45,418 - PRINT - ----------------------------------------------------------
-2024-11-18 10:47:45,418 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-11-18 10:47:45,418 - PRINT - ----------------------------------------------------------
-2024-11-18 10:47:45,423 - PRINT - Warning: No "method_plot" function in "methodplot.py" file implemented yet.
-2024-11-18 10:47:45,423 - WARNING - Warning: "html_output" switch in module configuration file set to "False". No HTML report generated.
-2024-11-18 10:47:45,424 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
-2024-11-18 10:47:45,425 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
-2024-11-18 10:47:45,425 - PRINT - Operating cost estimation finished.
-2024-11-18 10:48:55,251 - PRINT - Cost estimation started...
-2024-11-18 10:48:55,255 - PRINT - ----------------------------------------------------------
-2024-11-18 10:48:55,255 - PRINT - [No method implemented yet ("methodkerosene.py").]
-2024-11-18 10:48:55,255 - PRINT - ----------------------------------------------------------
-2024-11-18 10:48:55,260 - PRINT - Warning: No "method_plot" function in "methodplot.py" file implemented yet.
-2024-11-18 10:48:55,260 - WARNING - Warning: "html_output" switch in module configuration file set to "False". No HTML report generated.
-2024-11-18 10:48:55,261 - PRINT - Method-specific data are written to 'cost_estimation_results.xml'...
-2024-11-18 10:48:55,261 - WARNING - Warning: "tex_output" switch in module configuration file set to "False". No TeX report file generated.
-2024-11-18 10:48:55,261 - PRINT - Operating cost estimation finished.
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/main.py b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation.py
similarity index 100%
rename from docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/main.py
rename to docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/cost_estimation.py
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/Doxyfile b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/Doxyfile
deleted file mode 100644
index 1576c5a..0000000
--- a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/Doxyfile
+++ /dev/null
@@ -1,2824 +0,0 @@
-# Doxyfile 1.9.8
-
-# This file describes the settings to be used by the documentation system
-# doxygen (www.doxygen.org) for a project.
-#
-# All text after a double hash (##) is considered a comment and is placed in
-# front of the TAG it is preceding.
-#
-# All text after a single hash (#) is considered a comment and will be ignored.
-# The format is:
-# TAG = value [value, ...]
-# For lists, items can also be appended using:
-# TAG += value [value, ...]
-# Values that contain spaces should be placed between quotes (\" \").
-#
-# Note:
-#
-# Use doxygen to compare the used configuration file with the template
-# configuration file:
-# doxygen -x [configFile]
-# Use doxygen to compare the used configuration file with the template
-# configuration file without replacing the environment variables or CMake type
-# replacement variables:
-# doxygen -x_noenv [configFile]
-
-#---------------------------------------------------------------------------
-# Project related configuration options
-#---------------------------------------------------------------------------
-
-# This tag specifies the encoding used for all characters in the configuration
-# file that follow. The default is UTF-8 which is also the encoding used for all
-# text before the first occurrence of this tag. Doxygen uses libiconv (or the
-# iconv built into libc) for the transcoding. See
-# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
-# The default value is: UTF-8.
-
-DOXYFILE_ENCODING = UTF-8
-
-# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
-# double-quotes, unless you are using Doxywizard) that should identify the
-# project for which the documentation is generated. This name is used in the
-# title of most generated pages and in a few other places.
-# The default value is: My Project.
-
-PROJECT_NAME = "cost_estimation"
-
-# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
-# could be handy for archiving the generated documentation or if some version
-# control system is used.
-
-PROJECT_NUMBER =
-
-# Using the PROJECT_BRIEF tag one can provide an optional one line description
-# for a project that appears at the top of each page and should give viewer a
-# quick idea about the purpose of the project. Keep the description short.
-
-PROJECT_BRIEF =
-
-# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
-# in the documentation. The maximum height of the logo should not exceed 55
-# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
-# the logo to the output directory.
-
-PROJECT_LOGO =
-
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
-# into which the generated documentation will be written. If a relative path is
-# entered, it will be relative to the location where doxygen was started. If
-# left blank the current directory will be used.
-
-OUTPUT_DIRECTORY = .
-
-# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
-# sub-directories (in 2 levels) under the output directory of each output format
-# and will distribute the generated files over these directories. Enabling this
-# option can be useful when feeding doxygen a huge amount of source files, where
-# putting all generated files in the same directory would otherwise causes
-# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
-# control the number of sub-directories.
-# The default value is: NO.
-
-CREATE_SUBDIRS = NO
-
-# Controls the number of sub-directories that will be created when
-# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
-# level increment doubles the number of directories, resulting in 4096
-# directories at level 8 which is the default and also the maximum value. The
-# sub-directories are organized in 2 levels, the first level always has a fixed
-# number of 16 directories.
-# Minimum value: 0, maximum value: 8, default value: 8.
-# This tag requires that the tag CREATE_SUBDIRS is set to YES.
-
-CREATE_SUBDIRS_LEVEL = 8
-
-# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
-# characters to appear in the names of generated files. If set to NO, non-ASCII
-# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
-# U+3044.
-# The default value is: NO.
-
-ALLOW_UNICODE_NAMES = NO
-
-# The OUTPUT_LANGUAGE tag is used to specify the language in which all
-# documentation generated by doxygen is written. Doxygen will use this
-# information to generate all constant output in the proper language.
-# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
-# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
-# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
-# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
-# English messages), Korean, Korean-en (Korean with English messages), Latvian,
-# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
-# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
-# Swedish, Turkish, Ukrainian and Vietnamese.
-# The default value is: English.
-
-OUTPUT_LANGUAGE = English
-
-# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
-# descriptions after the members that are listed in the file and class
-# documentation (similar to Javadoc). Set to NO to disable this.
-# The default value is: YES.
-
-BRIEF_MEMBER_DESC = YES
-
-# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
-# description of a member or function before the detailed description
-#
-# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
-# brief descriptions will be completely suppressed.
-# The default value is: YES.
-
-REPEAT_BRIEF = YES
-
-# This tag implements a quasi-intelligent brief description abbreviator that is
-# used to form the text in various listings. Each string in this list, if found
-# as the leading text of the brief description, will be stripped from the text
-# and the result, after processing the whole list, is used as the annotated
-# text. Otherwise, the brief description is used as-is. If left blank, the
-# following values are used ($name is automatically replaced with the name of
-# the entity):The $name class, The $name widget, The $name file, is, provides,
-# specifies, contains, represents, a, an and the.
-
-ABBREVIATE_BRIEF = "The $name class" \
- "The $name widget" \
- "The $name file" \
- is \
- provides \
- specifies \
- contains \
- represents \
- a \
- an \
- the
-
-# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
-# doxygen will generate a detailed section even if there is only a brief
-# description.
-# The default value is: NO.
-
-ALWAYS_DETAILED_SEC = NO
-
-# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
-# inherited members of a class in the documentation of that class as if those
-# members were ordinary class members. Constructors, destructors and assignment
-# operators of the base classes will not be shown.
-# The default value is: NO.
-
-INLINE_INHERITED_MEMB = NO
-
-# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
-# before files name in the file list and in the header files. If set to NO the
-# shortest path that makes the file name unique will be used
-# The default value is: YES.
-
-FULL_PATH_NAMES = YES
-
-# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
-# Stripping is only done if one of the specified strings matches the left-hand
-# part of the path. The tag can be used to show relative paths in the file list.
-# If left blank the directory from which doxygen is run is used as the path to
-# strip.
-#
-# Note that you can specify absolute paths here, but also relative paths, which
-# will be relative from the directory where doxygen is started.
-# This tag requires that the tag FULL_PATH_NAMES is set to YES.
-
-STRIP_FROM_PATH =
-
-# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
-# path mentioned in the documentation of a class, which tells the reader which
-# header file to include in order to use a class. If left blank only the name of
-# the header file containing the class definition is used. Otherwise one should
-# specify the list of include paths that are normally passed to the compiler
-# using the -I flag.
-
-STRIP_FROM_INC_PATH =
-
-# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
-# less readable) file names. This can be useful is your file systems doesn't
-# support long names like on DOS, Mac, or CD-ROM.
-# The default value is: NO.
-
-SHORT_NAMES = NO
-
-# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
-# first line (until the first dot) of a Javadoc-style comment as the brief
-# description. If set to NO, the Javadoc-style will behave just like regular Qt-
-# style comments (thus requiring an explicit @brief command for a brief
-# description.)
-# The default value is: NO.
-
-JAVADOC_AUTOBRIEF = NO
-
-# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
-# such as
-# /***************
-# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
-# Javadoc-style will behave just like regular comments and it will not be
-# interpreted by doxygen.
-# The default value is: NO.
-
-JAVADOC_BANNER = NO
-
-# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
-# line (until the first dot) of a Qt-style comment as the brief description. If
-# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
-# requiring an explicit \brief command for a brief description.)
-# The default value is: NO.
-
-QT_AUTOBRIEF = NO
-
-# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
-# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
-# a brief description. This used to be the default behavior. The new default is
-# to treat a multi-line C++ comment block as a detailed description. Set this
-# tag to YES if you prefer the old behavior instead.
-#
-# Note that setting this tag to YES also means that rational rose comments are
-# not recognized any more.
-# The default value is: NO.
-
-MULTILINE_CPP_IS_BRIEF = NO
-
-# By default Python docstrings are displayed as preformatted text and doxygen's
-# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
-# doxygen's special commands can be used and the contents of the docstring
-# documentation blocks is shown as doxygen documentation.
-# The default value is: YES.
-
-PYTHON_DOCSTRING = YES
-
-# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
-# documentation from any documented member that it re-implements.
-# The default value is: YES.
-
-INHERIT_DOCS = YES
-
-# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
-# page for each member. If set to NO, the documentation of a member will be part
-# of the file/class/namespace that contains it.
-# The default value is: NO.
-
-SEPARATE_MEMBER_PAGES = NO
-
-# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
-# uses this value to replace tabs by spaces in code fragments.
-# Minimum value: 1, maximum value: 16, default value: 4.
-
-TAB_SIZE = 4
-
-# This tag can be used to specify a number of aliases that act as commands in
-# the documentation. An alias has the form:
-# name=value
-# For example adding
-# "sideeffect=@par Side Effects:^^"
-# will allow you to put the command \sideeffect (or @sideeffect) in the
-# documentation, which will result in a user-defined paragraph with heading
-# "Side Effects:". Note that you cannot put \n's in the value part of an alias
-# to insert newlines (in the resulting output). You can put ^^ in the value part
-# of an alias to insert a newline as if a physical newline was in the original
-# file. When you need a literal { or } or , in the value part of an alias you
-# have to escape them by means of a backslash (\), this can lead to conflicts
-# with the commands \{ and \} for these it is advised to use the version @{ and
-# @} or use a double escape (\\{ and \\})
-
-ALIASES =
-
-# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
-# only. Doxygen will then generate output that is more tailored for C. For
-# instance, some of the names that are used will be different. The list of all
-# members will be omitted, etc.
-# The default value is: NO.
-
-OPTIMIZE_OUTPUT_FOR_C = NO
-
-# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
-# Python sources only. Doxygen will then generate output that is more tailored
-# for that language. For instance, namespaces will be presented as packages,
-# qualified scopes will look different, etc.
-# The default value is: NO.
-
-OPTIMIZE_OUTPUT_JAVA = NO
-
-# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
-# sources. Doxygen will then generate output that is tailored for Fortran.
-# The default value is: NO.
-
-OPTIMIZE_FOR_FORTRAN = NO
-
-# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
-# sources. Doxygen will then generate output that is tailored for VHDL.
-# The default value is: NO.
-
-OPTIMIZE_OUTPUT_VHDL = NO
-
-# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
-# sources only. Doxygen will then generate output that is more tailored for that
-# language. For instance, namespaces will be presented as modules, types will be
-# separated into more groups, etc.
-# The default value is: NO.
-
-OPTIMIZE_OUTPUT_SLICE = NO
-
-# Doxygen selects the parser to use depending on the extension of the files it
-# parses. With this tag you can assign which parser to use for a given
-# extension. Doxygen has a built-in mapping, but you can override or extend it
-# using this tag. The format is ext=language, where ext is a file extension, and
-# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
-# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
-# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
-# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
-# tries to guess whether the code is fixed or free formatted code, this is the
-# default for Fortran type files). For instance to make doxygen treat .inc files
-# as Fortran files (default is PHP), and .f files as C (default is Fortran),
-# use: inc=Fortran f=C.
-#
-# Note: For files without extension you can use no_extension as a placeholder.
-#
-# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
-# the files are not read by doxygen. When specifying no_extension you should add
-# * to the FILE_PATTERNS.
-#
-# Note see also the list of default file extension mappings.
-
-EXTENSION_MAPPING =
-
-# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
-# according to the Markdown format, which allows for more readable
-# documentation. See https://daringfireball.net/projects/markdown/ for details.
-# The output of markdown processing is further processed by doxygen, so you can
-# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
-# case of backward compatibilities issues.
-# The default value is: YES.
-
-MARKDOWN_SUPPORT = YES
-
-# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
-# to that level are automatically included in the table of contents, even if
-# they do not have an id attribute.
-# Note: This feature currently applies only to Markdown headings.
-# Minimum value: 0, maximum value: 99, default value: 5.
-# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
-
-TOC_INCLUDE_HEADINGS = 5
-
-# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
-# generate identifiers for the Markdown headings. Note: Every identifier is
-# unique.
-# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
-# sequence number starting at 0 and GITHUB use the lower case version of title
-# with any whitespace replaced by '-' and punctuation characters removed.
-# The default value is: DOXYGEN.
-# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
-
-MARKDOWN_ID_STYLE = DOXYGEN
-
-# When enabled doxygen tries to link words that correspond to documented
-# classes, or namespaces to their corresponding documentation. Such a link can
-# be prevented in individual cases by putting a % sign in front of the word or
-# globally by setting AUTOLINK_SUPPORT to NO.
-# The default value is: YES.
-
-AUTOLINK_SUPPORT = YES
-
-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
-# to include (a tag file for) the STL sources as input, then you should set this
-# tag to YES in order to let doxygen match functions declarations and
-# definitions whose arguments contain STL classes (e.g. func(std::string);
-# versus func(std::string) {}). This also make the inheritance and collaboration
-# diagrams that involve STL classes more complete and accurate.
-# The default value is: NO.
-
-BUILTIN_STL_SUPPORT = NO
-
-# If you use Microsoft's C++/CLI language, you should set this option to YES to
-# enable parsing support.
-# The default value is: NO.
-
-CPP_CLI_SUPPORT = NO
-
-# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
-# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
-# will parse them like normal C++ but will assume all classes use public instead
-# of private inheritance when no explicit protection keyword is present.
-# The default value is: NO.
-
-SIP_SUPPORT = NO
-
-# For Microsoft's IDL there are propget and propput attributes to indicate
-# getter and setter methods for a property. Setting this option to YES will make
-# doxygen to replace the get and set methods by a property in the documentation.
-# This will only work if the methods are indeed getting or setting a simple
-# type. If this is not the case, or you want to show the methods anyway, you
-# should set this option to NO.
-# The default value is: YES.
-
-IDL_PROPERTY_SUPPORT = YES
-
-# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
-# tag is set to YES then doxygen will reuse the documentation of the first
-# member in the group (if any) for the other members of the group. By default
-# all members of a group must be documented explicitly.
-# The default value is: NO.
-
-DISTRIBUTE_GROUP_DOC = NO
-
-# If one adds a struct or class to a group and this option is enabled, then also
-# any nested class or struct is added to the same group. By default this option
-# is disabled and one has to add nested compounds explicitly via \ingroup.
-# The default value is: NO.
-
-GROUP_NESTED_COMPOUNDS = NO
-
-# Set the SUBGROUPING tag to YES to allow class member groups of the same type
-# (for instance a group of public functions) to be put as a subgroup of that
-# type (e.g. under the Public Functions section). Set it to NO to prevent
-# subgrouping. Alternatively, this can be done per class using the
-# \nosubgrouping command.
-# The default value is: YES.
-
-SUBGROUPING = YES
-
-# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
-# are shown inside the group in which they are included (e.g. using \ingroup)
-# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
-# and RTF).
-#
-# Note that this feature does not work in combination with
-# SEPARATE_MEMBER_PAGES.
-# The default value is: NO.
-
-INLINE_GROUPED_CLASSES = NO
-
-# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
-# with only public data fields or simple typedef fields will be shown inline in
-# the documentation of the scope in which they are defined (i.e. file,
-# namespace, or group documentation), provided this scope is documented. If set
-# to NO, structs, classes, and unions are shown on a separate page (for HTML and
-# Man pages) or section (for LaTeX and RTF).
-# The default value is: NO.
-
-INLINE_SIMPLE_STRUCTS = NO
-
-# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
-# enum is documented as struct, union, or enum with the name of the typedef. So
-# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
-# with name TypeT. When disabled the typedef will appear as a member of a file,
-# namespace, or class. And the struct will be named TypeS. This can typically be
-# useful for C code in case the coding convention dictates that all compound
-# types are typedef'ed and only the typedef is referenced, never the tag name.
-# The default value is: NO.
-
-TYPEDEF_HIDES_STRUCT = NO
-
-# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
-# cache is used to resolve symbols given their name and scope. Since this can be
-# an expensive process and often the same symbol appears multiple times in the
-# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
-# doxygen will become slower. If the cache is too large, memory is wasted. The
-# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
-# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
-# symbols. At the end of a run doxygen will report the cache usage and suggest
-# the optimal cache size from a speed point of view.
-# Minimum value: 0, maximum value: 9, default value: 0.
-
-LOOKUP_CACHE_SIZE = 0
-
-# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
-# during processing. When set to 0 doxygen will based this on the number of
-# cores available in the system. You can set it explicitly to a value larger
-# than 0 to get more control over the balance between CPU load and processing
-# speed. At this moment only the input processing can be done using multiple
-# threads. Since this is still an experimental feature the default is set to 1,
-# which effectively disables parallel processing. Please report any issues you
-# encounter. Generating dot graphs in parallel is controlled by the
-# DOT_NUM_THREADS setting.
-# Minimum value: 0, maximum value: 32, default value: 1.
-
-NUM_PROC_THREADS = 1
-
-# If the TIMESTAMP tag is set different from NO then each generated page will
-# contain the date or date and time when the page was generated. Setting this to
-# NO can help when comparing the output of multiple runs.
-# Possible values are: YES, NO, DATETIME and DATE.
-# The default value is: NO.
-
-TIMESTAMP = NO
-
-#---------------------------------------------------------------------------
-# Build related configuration options
-#---------------------------------------------------------------------------
-
-# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
-# documentation are documented, even if no documentation was available. Private
-# class members and static file members will be hidden unless the
-# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
-# Note: This will also disable the warnings about undocumented members that are
-# normally produced when WARNINGS is set to YES.
-# The default value is: NO.
-
-EXTRACT_ALL = YES
-
-# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
-# be included in the documentation.
-# The default value is: NO.
-
-EXTRACT_PRIVATE = YES
-
-# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
-# methods of a class will be included in the documentation.
-# The default value is: NO.
-
-EXTRACT_PRIV_VIRTUAL = YES
-
-# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
-# scope will be included in the documentation.
-# The default value is: NO.
-
-EXTRACT_PACKAGE = YES
-
-# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
-# included in the documentation.
-# The default value is: NO.
-
-EXTRACT_STATIC = YES
-
-# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
-# locally in source files will be included in the documentation. If set to NO,
-# only classes defined in header files are included. Does not have any effect
-# for Java sources.
-# The default value is: YES.
-
-EXTRACT_LOCAL_CLASSES = YES
-
-# This flag is only useful for Objective-C code. If set to YES, local methods,
-# which are defined in the implementation section but not in the interface are
-# included in the documentation. If set to NO, only methods in the interface are
-# included.
-# The default value is: NO.
-
-EXTRACT_LOCAL_METHODS = YES
-
-# If this flag is set to YES, the members of anonymous namespaces will be
-# extracted and appear in the documentation as a namespace called
-# 'anonymous_namespace{file}', where file will be replaced with the base name of
-# the file that contains the anonymous namespace. By default anonymous namespace
-# are hidden.
-# The default value is: NO.
-
-EXTRACT_ANON_NSPACES = YES
-
-# If this flag is set to YES, the name of an unnamed parameter in a declaration
-# will be determined by the corresponding definition. By default unnamed
-# parameters remain unnamed in the output.
-# The default value is: YES.
-
-RESOLVE_UNNAMED_PARAMS = YES
-
-# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
-# undocumented members inside documented classes or files. If set to NO these
-# members will be included in the various overviews, but no documentation
-# section is generated. This option has no effect if EXTRACT_ALL is enabled.
-# The default value is: NO.
-
-HIDE_UNDOC_MEMBERS = NO
-
-# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
-# undocumented classes that are normally visible in the class hierarchy. If set
-# to NO, these classes will be included in the various overviews. This option
-# will also hide undocumented C++ concepts if enabled. This option has no effect
-# if EXTRACT_ALL is enabled.
-# The default value is: NO.
-
-HIDE_UNDOC_CLASSES = NO
-
-# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
-# declarations. If set to NO, these declarations will be included in the
-# documentation.
-# The default value is: NO.
-
-HIDE_FRIEND_COMPOUNDS = NO
-
-# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
-# documentation blocks found inside the body of a function. If set to NO, these
-# blocks will be appended to the function's detailed documentation block.
-# The default value is: NO.
-
-HIDE_IN_BODY_DOCS = NO
-
-# The INTERNAL_DOCS tag determines if documentation that is typed after a
-# \internal command is included. If the tag is set to NO then the documentation
-# will be excluded. Set it to YES to include the internal documentation.
-# The default value is: NO.
-
-INTERNAL_DOCS = NO
-
-# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
-# able to match the capabilities of the underlying filesystem. In case the
-# filesystem is case sensitive (i.e. it supports files in the same directory
-# whose names only differ in casing), the option must be set to YES to properly
-# deal with such files in case they appear in the input. For filesystems that
-# are not case sensitive the option should be set to NO to properly deal with
-# output files written for symbols that only differ in casing, such as for two
-# classes, one named CLASS and the other named Class, and to also support
-# references to files without having to specify the exact matching casing. On
-# Windows (including Cygwin) and MacOS, users should typically set this option
-# to NO, whereas on Linux or other Unix flavors it should typically be set to
-# YES.
-# Possible values are: SYSTEM, NO and YES.
-# The default value is: SYSTEM.
-
-CASE_SENSE_NAMES = SYSTEM
-
-# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
-# their full class and namespace scopes in the documentation. If set to YES, the
-# scope will be hidden.
-# The default value is: NO.
-
-HIDE_SCOPE_NAMES = NO
-
-# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
-# append additional text to a page's title, such as Class Reference. If set to
-# YES the compound reference will be hidden.
-# The default value is: NO.
-
-HIDE_COMPOUND_REFERENCE= NO
-
-# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
-# will show which file needs to be included to use the class.
-# The default value is: YES.
-
-SHOW_HEADERFILE = YES
-
-# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
-# the files that are included by a file in the documentation of that file.
-# The default value is: YES.
-
-SHOW_INCLUDE_FILES = YES
-
-# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
-# grouped member an include statement to the documentation, telling the reader
-# which file to include in order to use the member.
-# The default value is: NO.
-
-SHOW_GROUPED_MEMB_INC = NO
-
-# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
-# files with double quotes in the documentation rather than with sharp brackets.
-# The default value is: NO.
-
-FORCE_LOCAL_INCLUDES = NO
-
-# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
-# documentation for inline members.
-# The default value is: YES.
-
-INLINE_INFO = YES
-
-# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
-# (detailed) documentation of file and class members alphabetically by member
-# name. If set to NO, the members will appear in declaration order.
-# The default value is: YES.
-
-SORT_MEMBER_DOCS = YES
-
-# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
-# descriptions of file, namespace and class members alphabetically by member
-# name. If set to NO, the members will appear in declaration order. Note that
-# this will also influence the order of the classes in the class list.
-# The default value is: NO.
-
-SORT_BRIEF_DOCS = NO
-
-# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
-# (brief and detailed) documentation of class members so that constructors and
-# destructors are listed first. If set to NO the constructors will appear in the
-# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
-# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
-# member documentation.
-# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
-# detailed member documentation.
-# The default value is: NO.
-
-SORT_MEMBERS_CTORS_1ST = NO
-
-# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
-# of group names into alphabetical order. If set to NO the group names will
-# appear in their defined order.
-# The default value is: NO.
-
-SORT_GROUP_NAMES = NO
-
-# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
-# fully-qualified names, including namespaces. If set to NO, the class list will
-# be sorted only by class name, not including the namespace part.
-# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
-# Note: This option applies only to the class list, not to the alphabetical
-# list.
-# The default value is: NO.
-
-SORT_BY_SCOPE_NAME = NO
-
-# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
-# type resolution of all parameters of a function it will reject a match between
-# the prototype and the implementation of a member function even if there is
-# only one candidate or it is obvious which candidate to choose by doing a
-# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
-# accept a match between prototype and implementation in such cases.
-# The default value is: NO.
-
-STRICT_PROTO_MATCHING = NO
-
-# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
-# list. This list is created by putting \todo commands in the documentation.
-# The default value is: YES.
-
-GENERATE_TODOLIST = YES
-
-# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
-# list. This list is created by putting \test commands in the documentation.
-# The default value is: YES.
-
-GENERATE_TESTLIST = YES
-
-# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
-# list. This list is created by putting \bug commands in the documentation.
-# The default value is: YES.
-
-GENERATE_BUGLIST = YES
-
-# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
-# the deprecated list. This list is created by putting \deprecated commands in
-# the documentation.
-# The default value is: YES.
-
-GENERATE_DEPRECATEDLIST= YES
-
-# The ENABLED_SECTIONS tag can be used to enable conditional documentation
-# sections, marked by \if <section_label> ... \endif and \cond <section_label>
-# ... \endcond blocks.
-
-ENABLED_SECTIONS =
-
-# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
-# initial value of a variable or macro / define can have for it to appear in the
-# documentation. If the initializer consists of more lines than specified here
-# it will be hidden. Use a value of 0 to hide initializers completely. The
-# appearance of the value of individual variables and macros / defines can be
-# controlled using \showinitializer or \hideinitializer command in the
-# documentation regardless of this setting.
-# Minimum value: 0, maximum value: 10000, default value: 30.
-
-MAX_INITIALIZER_LINES = 30
-
-# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
-# the bottom of the documentation of classes and structs. If set to YES, the
-# list will mention the files that were used to generate the documentation.
-# The default value is: YES.
-
-SHOW_USED_FILES = YES
-
-# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
-# will remove the Files entry from the Quick Index and from the Folder Tree View
-# (if specified).
-# The default value is: YES.
-
-SHOW_FILES = YES
-
-# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
-# page. This will remove the Namespaces entry from the Quick Index and from the
-# Folder Tree View (if specified).
-# The default value is: YES.
-
-SHOW_NAMESPACES = YES
-
-# The FILE_VERSION_FILTER tag can be used to specify a program or script that
-# doxygen should invoke to get the current version for each file (typically from
-# the version control system). Doxygen will invoke the program by executing (via
-# popen()) the command command input-file, where command is the value of the
-# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
-# by doxygen. Whatever the program writes to standard output is used as the file
-# version. For an example see the documentation.
-
-FILE_VERSION_FILTER =
-
-# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
-# by doxygen. The layout file controls the global structure of the generated
-# output files in an output format independent way. To create the layout file
-# that represents doxygen's defaults, run doxygen with the -l option. You can
-# optionally specify a file name after the option, if omitted DoxygenLayout.xml
-# will be used as the name of the layout file. See also section "Changing the
-# layout of pages" for information.
-#
-# Note that if you run doxygen from a directory containing a file called
-# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
-# tag is left empty.
-
-LAYOUT_FILE =
-
-# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
-# the reference definitions. This must be a list of .bib files. The .bib
-# extension is automatically appended if omitted. This requires the bibtex tool
-# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
-# For LaTeX the style of the bibliography can be controlled using
-# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
-# search path. See also \cite for info how to create references.
-
-CITE_BIB_FILES = literature.bib
-
-#---------------------------------------------------------------------------
-# Configuration options related to warning and progress messages
-#---------------------------------------------------------------------------
-
-# The QUIET tag can be used to turn on/off the messages that are generated to
-# standard output by doxygen. If QUIET is set to YES this implies that the
-# messages are off.
-# The default value is: NO.
-
-QUIET = NO
-
-# The WARNINGS tag can be used to turn on/off the warning messages that are
-# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
-# this implies that the warnings are on.
-#
-# Tip: Turn warnings on while writing the documentation.
-# The default value is: YES.
-
-WARNINGS = YES
-
-# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
-# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
-# will automatically be disabled.
-# The default value is: YES.
-
-WARN_IF_UNDOCUMENTED = YES
-
-# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
-# potential errors in the documentation, such as documenting some parameters in
-# a documented function twice, or documenting parameters that don't exist or
-# using markup commands wrongly.
-# The default value is: YES.
-
-WARN_IF_DOC_ERROR = YES
-
-# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
-# function parameter documentation. If set to NO, doxygen will accept that some
-# parameters have no documentation without warning.
-# The default value is: YES.
-
-WARN_IF_INCOMPLETE_DOC = YES
-
-# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
-# are documented, but have no documentation for their parameters or return
-# value. If set to NO, doxygen will only warn about wrong parameter
-# documentation, but not about the absence of documentation. If EXTRACT_ALL is
-# set to YES then this flag will automatically be disabled. See also
-# WARN_IF_INCOMPLETE_DOC
-# The default value is: NO.
-
-WARN_NO_PARAMDOC = NO
-
-# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
-# undocumented enumeration values. If set to NO, doxygen will accept
-# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
-# will automatically be disabled.
-# The default value is: NO.
-
-WARN_IF_UNDOC_ENUM_VAL = NO
-
-# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
-# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
-# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
-# at the end of the doxygen process doxygen will return with a non-zero status.
-# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves
-# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
-# write the warning messages in between other messages but write them at the end
-# of a run, in case a WARN_LOGFILE is defined the warning messages will be
-# besides being in the defined file also be shown at the end of a run, unless
-# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
-# the behavior will remain as with the setting FAIL_ON_WARNINGS.
-# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
-# The default value is: NO.
-
-WARN_AS_ERROR = NO
-
-# The WARN_FORMAT tag determines the format of the warning messages that doxygen
-# can produce. The string should contain the $file, $line, and $text tags, which
-# will be replaced by the file and line number from which the warning originated
-# and the warning text. Optionally the format may contain $version, which will
-# be replaced by the version of the file (if it could be obtained via
-# FILE_VERSION_FILTER)
-# See also: WARN_LINE_FORMAT
-# The default value is: $file:$line: $text.
-
-WARN_FORMAT = "$file:$line: $text"
-
-# In the $text part of the WARN_FORMAT command it is possible that a reference
-# to a more specific place is given. To make it easier to jump to this place
-# (outside of doxygen) the user can define a custom "cut" / "paste" string.
-# Example:
-# WARN_LINE_FORMAT = "'vi $file +$line'"
-# See also: WARN_FORMAT
-# The default value is: at line $line of file $file.
-
-WARN_LINE_FORMAT = "at line $line of file $file"
-
-# The WARN_LOGFILE tag can be used to specify a file to which warning and error
-# messages should be written. If left blank the output is written to standard
-# error (stderr). In case the file specified cannot be opened for writing the
-# warning and error messages are written to standard error. When as file - is
-# specified the warning and error messages are written to standard output
-# (stdout).
-
-WARN_LOGFILE =
-
-#---------------------------------------------------------------------------
-# Configuration options related to the input files
-#---------------------------------------------------------------------------
-
-# The INPUT tag is used to specify the files and/or directories that contain
-# documented source files. You may enter file names like myfile.cpp or
-# directories like /usr/src/myproject. Separate the files or directories with
-# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
-# Note: If this tag is empty the current directory is searched.
-
-INPUT = ../src/ ./content/
-
-# This tag can be used to specify the character encoding of the source files
-# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
-# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
-# documentation (see:
-# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
-# See also: INPUT_FILE_ENCODING
-# The default value is: UTF-8.
-
-INPUT_ENCODING = UTF-8
-
-# This tag can be used to specify the character encoding of the source files
-# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
-# character encoding on a per file pattern basis. Doxygen will compare the file
-# name with each pattern and apply the encoding instead of the default
-# INPUT_ENCODING) if there is a match. The character encodings are a list of the
-# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
-# "INPUT_ENCODING" for further information on supported encodings.
-
-INPUT_FILE_ENCODING =
-
-# If the value of the INPUT tag contains directories, you can use the
-# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
-# *.h) to filter out the source-files in the directories.
-#
-# Note that for custom extensions or not directly supported extensions you also
-# need to set EXTENSION_MAPPING for the extension otherwise the files are not
-# read by doxygen.
-#
-# Note the list of default checked file patterns might differ from the list of
-# default file extension mappings.
-#
-# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
-# *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl,
-# *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php,
-# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be
-# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
-# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
-
-FILE_PATTERNS = *.c \
- *.cc \
- *.cxx \
- *.cxxm \
- *.cpp \
- *.cppm \
- *.c++ \
- *.c++m \
- *.java \
- *.ii \
- *.ixx \
- *.ipp \
- *.i++ \
- *.inl \
- *.idl \
- *.ddl \
- *.odl \
- *.h \
- *.hh \
- *.hxx \
- *.hpp \
- *.h++ \
- *.ixx \
- *.l \
- *.cs \
- *.d \
- *.php \
- *.php4 \
- *.php5 \
- *.phtml \
- *.inc \
- *.m \
- *.markdown \
- *.md \
- *.mm \
- *.dox \
- *.py \
- *.pyw \
- *.f90 \
- *.f95 \
- *.f03 \
- *.f08 \
- *.f18 \
- *.f \
- *.for \
- *.vhd \
- *.vhdl \
- *.ucf \
- *.qsf \
- *.ice
-
-# The RECURSIVE tag can be used to specify whether or not subdirectories should
-# be searched for input files as well.
-# The default value is: NO.
-
-RECURSIVE = YES
-
-# The EXCLUDE tag can be used to specify files and/or directories that should be
-# excluded from the INPUT source files. This way you can easily exclude a
-# subdirectory from a directory tree whose root is specified with the INPUT tag.
-#
-# Note that relative paths are relative to the directory from which doxygen is
-# run.
-
-EXCLUDE =
-
-# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
-# directories that are symbolic links (a Unix file system feature) are excluded
-# from the input.
-# The default value is: NO.
-
-EXCLUDE_SYMLINKS = NO
-
-# If the value of the INPUT tag contains directories, you can use the
-# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
-# certain files from those directories.
-#
-# Note that the wildcards are matched against the file with absolute path, so to
-# exclude all test directories for example use the pattern */test/*
-
-EXCLUDE_PATTERNS =
-
-# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
-# (namespaces, classes, functions, etc.) that should be excluded from the
-# output. The symbol name can be a fully qualified name, a word, or if the
-# wildcard * is used, a substring. Examples: ANamespace, AClass,
-# ANamespace::AClass, ANamespace::*Test
-
-EXCLUDE_SYMBOLS =
-
-# The EXAMPLE_PATH tag can be used to specify one or more files or directories
-# that contain example code fragments that are included (see the \include
-# command).
-
-EXAMPLE_PATH =
-
-# If the value of the EXAMPLE_PATH tag contains directories, you can use the
-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
-# *.h) to filter out the source-files in the directories. If left blank all
-# files are included.
-
-EXAMPLE_PATTERNS = *
-
-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
-# searched for input files to be used with the \include or \dontinclude commands
-# irrespective of the value of the RECURSIVE tag.
-# The default value is: NO.
-
-EXAMPLE_RECURSIVE = NO
-
-# The IMAGE_PATH tag can be used to specify one or more files or directories
-# that contain images that are to be included in the documentation (see the
-# \image command).
-
-IMAGE_PATH = ./img/
-
-# The INPUT_FILTER tag can be used to specify a program that doxygen should
-# invoke to filter for each input file. Doxygen will invoke the filter program
-# by executing (via popen()) the command:
-#
-# <filter> <input-file>
-#
-# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
-# name of an input file. Doxygen will then use the output that the filter
-# program writes to standard output. If FILTER_PATTERNS is specified, this tag
-# will be ignored.
-#
-# Note that the filter must not add or remove lines; it is applied before the
-# code is scanned, but not when the output code is generated. If lines are added
-# or removed, the anchors will not be placed correctly.
-#
-# Note that doxygen will use the data processed and written to standard output
-# for further processing, therefore nothing else, like debug statements or used
-# commands (so in case of a Windows batch file always use @echo OFF), should be
-# written to standard output.
-#
-# Note that for custom extensions or not directly supported extensions you also
-# need to set EXTENSION_MAPPING for the extension otherwise the files are not
-# properly processed by doxygen.
-
-INPUT_FILTER =
-
-# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
-# basis. Doxygen will compare the file name with each pattern and apply the
-# filter if there is a match. The filters are a list of the form: pattern=filter
-# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
-# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
-# patterns match the file name, INPUT_FILTER is applied.
-#
-# Note that for custom extensions or not directly supported extensions you also
-# need to set EXTENSION_MAPPING for the extension otherwise the files are not
-# properly processed by doxygen.
-
-FILTER_PATTERNS =
-
-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
-# INPUT_FILTER) will also be used to filter the input files that are used for
-# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
-# The default value is: NO.
-
-FILTER_SOURCE_FILES = NO
-
-# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
-# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
-# it is also possible to disable source filtering for a specific pattern using
-# *.ext= (so without naming a filter).
-# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
-
-FILTER_SOURCE_PATTERNS =
-
-# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
-# is part of the input, its contents will be placed on the main page
-# (index.html). This can be useful if you have a project on for instance GitHub
-# and want to reuse the introduction page also for the doxygen output.
-
-USE_MDFILE_AS_MAINPAGE =
-
-# The Fortran standard specifies that for fixed formatted Fortran code all
-# characters from position 72 are to be considered as comment. A common
-# extension is to allow longer lines before the automatic comment starts. The
-# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
-# be processed before the automatic comment starts.
-# Minimum value: 7, maximum value: 10000, default value: 72.
-
-FORTRAN_COMMENT_AFTER = 72
-
-#---------------------------------------------------------------------------
-# Configuration options related to source browsing
-#---------------------------------------------------------------------------
-
-# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
-# generated. Documented entities will be cross-referenced with these sources.
-#
-# Note: To get rid of all source code in the generated output, make sure that
-# also VERBATIM_HEADERS is set to NO.
-# The default value is: NO.
-
-SOURCE_BROWSER = NO
-
-# Setting the INLINE_SOURCES tag to YES will include the body of functions,
-# classes and enums directly into the documentation.
-# The default value is: NO.
-
-INLINE_SOURCES = NO
-
-# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
-# special comment blocks from generated source code fragments. Normal C, C++ and
-# Fortran comments will always remain visible.
-# The default value is: YES.
-
-STRIP_CODE_COMMENTS = YES
-
-# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
-# entity all documented functions referencing it will be listed.
-# The default value is: NO.
-
-REFERENCED_BY_RELATION = NO
-
-# If the REFERENCES_RELATION tag is set to YES then for each documented function
-# all documented entities called/used by that function will be listed.
-# The default value is: NO.
-
-REFERENCES_RELATION = NO
-
-# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
-# to YES then the hyperlinks from functions in REFERENCES_RELATION and
-# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
-# link to the documentation.
-# The default value is: YES.
-
-REFERENCES_LINK_SOURCE = YES
-
-# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
-# source code will show a tooltip with additional information such as prototype,
-# brief description and links to the definition and documentation. Since this
-# will make the HTML file larger and loading of large files a bit slower, you
-# can opt to disable this feature.
-# The default value is: YES.
-# This tag requires that the tag SOURCE_BROWSER is set to YES.
-
-SOURCE_TOOLTIPS = YES
-
-# If the USE_HTAGS tag is set to YES then the references to source code will
-# point to the HTML generated by the htags(1) tool instead of doxygen built-in
-# source browser. The htags tool is part of GNU's global source tagging system
-# (see https://www.gnu.org/software/global/global.html). You will need version
-# 4.8.6 or higher.
-#
-# To use it do the following:
-# - Install the latest version of global
-# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
-# - Make sure the INPUT points to the root of the source tree
-# - Run doxygen as normal
-#
-# Doxygen will invoke htags (and that will in turn invoke gtags), so these
-# tools must be available from the command line (i.e. in the search path).
-#
-# The result: instead of the source browser generated by doxygen, the links to
-# source code will now point to the output of htags.
-# The default value is: NO.
-# This tag requires that the tag SOURCE_BROWSER is set to YES.
-
-USE_HTAGS = NO
-
-# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
-# verbatim copy of the header file for each class for which an include is
-# specified. Set to NO to disable this.
-# See also: Section \class.
-# The default value is: YES.
-
-VERBATIM_HEADERS = YES
-
-#---------------------------------------------------------------------------
-# Configuration options related to the alphabetical class index
-#---------------------------------------------------------------------------
-
-# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
-# compounds will be generated. Enable this if the project contains a lot of
-# classes, structs, unions or interfaces.
-# The default value is: YES.
-
-ALPHABETICAL_INDEX = YES
-
-# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
-# that should be ignored while generating the index headers. The IGNORE_PREFIX
-# tag works for classes, function and member names. The entity will be placed in
-# the alphabetical list under the first letter of the entity name that remains
-# after removing the prefix.
-# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-
-IGNORE_PREFIX =
-
-#---------------------------------------------------------------------------
-# Configuration options related to the HTML output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
-# The default value is: YES.
-
-GENERATE_HTML = YES
-
-# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
-# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
-# it.
-# The default directory is: html.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_OUTPUT = cost_estimation
-
-# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
-# generated HTML page (for example: .htm, .php, .asp).
-# The default value is: .html.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_FILE_EXTENSION = .html
-
-# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
-# each generated HTML page. If the tag is left blank doxygen will generate a
-# standard header.
-#
-# To get valid HTML the header file that includes any scripts and style sheets
-# that doxygen needs, which is dependent on the configuration options used (e.g.
-# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
-# default header using
-# doxygen -w html new_header.html new_footer.html new_stylesheet.css
-# YourConfigFile
-# and then modify the file new_header.html. See also section "Doxygen usage"
-# for information on how to generate the default header that doxygen normally
-# uses.
-# Note: The header is subject to change so you typically have to regenerate the
-# default header when upgrading to a newer version of doxygen. For a description
-# of the possible markers and block names see the documentation.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_HEADER = header.html
-
-# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
-# generated HTML page. If the tag is left blank doxygen will generate a standard
-# footer. See HTML_HEADER for more information on how to generate a default
-# footer and what special commands can be used inside the footer. See also
-# section "Doxygen usage" for information on how to generate the default footer
-# that doxygen normally uses.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_FOOTER =
-
-# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
-# sheet that is used by each HTML page. It can be used to fine-tune the look of
-# the HTML output. If left blank doxygen will generate a default style sheet.
-# See also section "Doxygen usage" for information on how to generate the style
-# sheet that doxygen normally uses.
-# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
-# it is more robust and this tag (HTML_STYLESHEET) will in the future become
-# obsolete.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_STYLESHEET =
-
-# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
-# cascading style sheets that are included after the standard style sheets
-# created by doxygen. Using this option one can overrule certain style aspects.
-# This is preferred over using HTML_STYLESHEET since it does not replace the
-# standard style sheet and is therefore more robust against future updates.
-# Doxygen will copy the style sheet files to the output directory.
-# Note: The order of the extra style sheet files is of importance (e.g. the last
-# style sheet in the list overrules the setting of the previous ones in the
-# list).
-# Note: Since the styling of scrollbars can currently not be overruled in
-# Webkit/Chromium, the styling will be left out of the default doxygen.css if
-# one or more extra stylesheets have been specified. So if scrollbar
-# customization is desired it has to be added explicitly. For an example see the
-# documentation.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_EXTRA_STYLESHEET = ../../libs/extern/doxygen-awesome-css/doxygen-awesome.css
-
-# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
-# other source files which should be copied to the HTML output directory. Note
-# that these files will be copied to the base HTML output directory. Use the
-# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
-# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
-# files will be copied as-is; there are no commands or markers available.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_EXTRA_FILES = ../../libs/extern/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js\
- ../../libs/extern/doxygen-awesome-css/doxygen-awesome-tabs.js\
- ../../libs/extern/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js
-
-# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
-# should be rendered with a dark or light theme.
-# Possible values are: LIGHT always generate light mode output, DARK always
-# generate dark mode output, AUTO_LIGHT automatically set the mode according to
-# the user preference, use light mode if no preference is set (the default),
-# AUTO_DARK automatically set the mode according to the user preference, use
-# dark mode if no preference is set and TOGGLE allow to user to switch between
-# light and dark mode via a button.
-# The default value is: AUTO_LIGHT.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_COLORSTYLE = LIGHT
-
-# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
-# will adjust the colors in the style sheet and background images according to
-# this color. Hue is specified as an angle on a color-wheel, see
-# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
-# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
-# purple, and 360 is red again.
-# Minimum value: 0, maximum value: 359, default value: 220.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_COLORSTYLE_HUE = 220
-
-# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
-# in the HTML output. For a value of 0 the output will use gray-scales only. A
-# value of 255 will produce the most vivid colors.
-# Minimum value: 0, maximum value: 255, default value: 100.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_COLORSTYLE_SAT = 100
-
-# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
-# luminance component of the colors in the HTML output. Values below 100
-# gradually make the output lighter, whereas values above 100 make the output
-# darker. The value divided by 100 is the actual gamma applied, so 80 represents
-# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
-# change the gamma.
-# Minimum value: 40, maximum value: 240, default value: 80.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_COLORSTYLE_GAMMA = 80
-
-# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
-# documentation will contain a main index with vertical navigation menus that
-# are dynamically created via JavaScript. If disabled, the navigation index will
-# consists of multiple levels of tabs that are statically embedded in every HTML
-# page. Disable this option to support browsers that do not have JavaScript,
-# like the Qt help browser.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_DYNAMIC_MENUS = YES
-
-# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
-# documentation will contain sections that can be hidden and shown after the
-# page has loaded.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_DYNAMIC_SECTIONS = NO
-
-# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
-# dynamically folded and expanded in the generated HTML source code.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_CODE_FOLDING = YES
-
-# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
-# shown in the various tree structured indices initially; the user can expand
-# and collapse entries dynamically later on. Doxygen will expand the tree to
-# such a level that at most the specified number of entries are visible (unless
-# a fully collapsed tree already exceeds this amount). So setting the number of
-# entries 1 will produce a full collapsed tree by default. 0 is a special value
-# representing an infinite number of entries and will result in a full expanded
-# tree by default.
-# Minimum value: 0, maximum value: 9999, default value: 100.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_INDEX_NUM_ENTRIES = 100
-
-# If the GENERATE_DOCSET tag is set to YES, additional index files will be
-# generated that can be used as input for Apple's Xcode 3 integrated development
-# environment (see:
-# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
-# create a documentation set, doxygen will generate a Makefile in the HTML
-# output directory. Running make will produce the docset in that directory and
-# running make install will install the docset in
-# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
-# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
-# genXcode/_index.html for more information.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-GENERATE_DOCSET = NO
-
-# This tag determines the name of the docset feed. A documentation feed provides
-# an umbrella under which multiple documentation sets from a single provider
-# (such as a company or product suite) can be grouped.
-# The default value is: Doxygen generated docs.
-# This tag requires that the tag GENERATE_DOCSET is set to YES.
-
-DOCSET_FEEDNAME = "Doxygen generated docs"
-
-# This tag determines the URL of the docset feed. A documentation feed provides
-# an umbrella under which multiple documentation sets from a single provider
-# (such as a company or product suite) can be grouped.
-# This tag requires that the tag GENERATE_DOCSET is set to YES.
-
-DOCSET_FEEDURL =
-
-# This tag specifies a string that should uniquely identify the documentation
-# set bundle. This should be a reverse domain-name style string, e.g.
-# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
-# The default value is: org.doxygen.Project.
-# This tag requires that the tag GENERATE_DOCSET is set to YES.
-
-DOCSET_BUNDLE_ID = org.doxygen.Project
-
-# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
-# the documentation publisher. This should be a reverse domain-name style
-# string, e.g. com.mycompany.MyDocSet.documentation.
-# The default value is: org.doxygen.Publisher.
-# This tag requires that the tag GENERATE_DOCSET is set to YES.
-
-DOCSET_PUBLISHER_ID = org.doxygen.Publisher
-
-# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
-# The default value is: Publisher.
-# This tag requires that the tag GENERATE_DOCSET is set to YES.
-
-DOCSET_PUBLISHER_NAME = Publisher
-
-# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
-# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
-# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
-# on Windows. In the beginning of 2021 Microsoft took the original page, with
-# a.o. the download links, offline the HTML help workshop was already many years
-# in maintenance mode). You can download the HTML help workshop from the web
-# archives at Installation executable (see:
-# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
-# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
-#
-# The HTML Help Workshop contains a compiler that can convert all HTML output
-# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
-# files are now used as the Windows 98 help format, and will replace the old
-# Windows help format (.hlp) on all Windows platforms in the future. Compressed
-# HTML files also contain an index, a table of contents, and you can search for
-# words in the documentation. The HTML workshop also contains a viewer for
-# compressed HTML files.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-GENERATE_HTMLHELP = NO
-
-# The CHM_FILE tag can be used to specify the file name of the resulting .chm
-# file. You can add a path in front of the file if the result should not be
-# written to the html output directory.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
-CHM_FILE =
-
-# The HHC_LOCATION tag can be used to specify the location (absolute path
-# including file name) of the HTML help compiler (hhc.exe). If non-empty,
-# doxygen will try to run the HTML help compiler on the generated index.hhp.
-# The file has to be specified with full path.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
-HHC_LOCATION =
-
-# The GENERATE_CHI flag controls if a separate .chi index file is generated
-# (YES) or that it should be included in the main .chm file (NO).
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
-GENERATE_CHI = NO
-
-# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
-# and project file content.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
-CHM_INDEX_ENCODING =
-
-# The BINARY_TOC flag controls whether a binary table of contents is generated
-# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
-# enables the Previous and Next buttons.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
-BINARY_TOC = NO
-
-# The TOC_EXPAND flag can be set to YES to add extra items for group members to
-# the table of contents of the HTML help documentation and to the tree view.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
-
-TOC_EXPAND = NO
-
-# The SITEMAP_URL tag is used to specify the full URL of the place where the
-# generated documentation will be placed on the server by the user during the
-# deployment of the documentation. The generated sitemap is called sitemap.xml
-# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
-# is specified no sitemap is generated. For information about the sitemap
-# protocol see https://www.sitemaps.org
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-SITEMAP_URL =
-
-# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
-# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
-# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
-# (.qch) of the generated HTML documentation.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-GENERATE_QHP = NO
-
-# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
-# the file name of the resulting .qch file. The path specified is relative to
-# the HTML output folder.
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
-QCH_FILE =
-
-# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
-# Project output. For more information please see Qt Help Project / Namespace
-# (see:
-# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
-# The default value is: org.doxygen.Project.
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
-QHP_NAMESPACE = org.doxygen.Project
-
-# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
-# Help Project output. For more information please see Qt Help Project / Virtual
-# Folders (see:
-# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
-# The default value is: doc.
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
-QHP_VIRTUAL_FOLDER = doc
-
-# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
-# filter to add. For more information please see Qt Help Project / Custom
-# Filters (see:
-# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
-QHP_CUST_FILTER_NAME =
-
-# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
-# custom filter to add. For more information please see Qt Help Project / Custom
-# Filters (see:
-# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
-QHP_CUST_FILTER_ATTRS =
-
-# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
-# project's filter section matches. Qt Help Project / Filter Attributes (see:
-# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
-QHP_SECT_FILTER_ATTRS =
-
-# The QHG_LOCATION tag can be used to specify the location (absolute path
-# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
-# run qhelpgenerator on the generated .qhp file.
-# This tag requires that the tag GENERATE_QHP is set to YES.
-
-QHG_LOCATION =
-
-# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
-# generated, together with the HTML files, they form an Eclipse help plugin. To
-# install this plugin and make it available under the help contents menu in
-# Eclipse, the contents of the directory containing the HTML and XML files needs
-# to be copied into the plugins directory of eclipse. The name of the directory
-# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
-# After copying Eclipse needs to be restarted before the help appears.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-GENERATE_ECLIPSEHELP = NO
-
-# A unique identifier for the Eclipse help plugin. When installing the plugin
-# the directory name containing the HTML and XML files should also have this
-# name. Each documentation set should have its own identifier.
-# The default value is: org.doxygen.Project.
-# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
-
-ECLIPSE_DOC_ID = org.doxygen.Project
-
-# If you want full control over the layout of the generated HTML pages it might
-# be necessary to disable the index and replace it with your own. The
-# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
-# of each HTML page. A value of NO enables the index and the value YES disables
-# it. Since the tabs in the index contain the same information as the navigation
-# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-DISABLE_INDEX = NO
-
-# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
-# structure should be generated to display hierarchical information. If the tag
-# value is set to YES, a side panel will be generated containing a tree-like
-# index structure (just like the one that is generated for HTML Help). For this
-# to work a browser that supports JavaScript, DHTML, CSS and frames is required
-# (i.e. any modern browser). Windows users are probably better off using the
-# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
-# further fine tune the look of the index (see "Fine-tuning the output"). As an
-# example, the default style sheet generated by doxygen has an example that
-# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
-# Since the tree basically has the same information as the tab index, you could
-# consider setting DISABLE_INDEX to YES when enabling this option.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-GENERATE_TREEVIEW = YES
-
-# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
-# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
-# area (value NO) or if it should extend to the full height of the window (value
-# YES). Setting this to YES gives a layout similar to
-# https://docs.readthedocs.io with more room for contents, but less room for the
-# project logo, title, and description. If either GENERATE_TREEVIEW or
-# DISABLE_INDEX is set to NO, this option has no effect.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-FULL_SIDEBAR = NO
-
-# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
-# doxygen will group on one line in the generated HTML documentation.
-#
-# Note that a value of 0 will completely suppress the enum values from appearing
-# in the overview section.
-# Minimum value: 0, maximum value: 20, default value: 4.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-ENUM_VALUES_PER_LINE = 4
-
-# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
-# to set the initial width (in pixels) of the frame in which the tree is shown.
-# Minimum value: 0, maximum value: 1500, default value: 250.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-TREEVIEW_WIDTH = 250
-
-# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
-# external symbols imported via tag files in a separate window.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-EXT_LINKS_IN_WINDOW = NO
-
-# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
-# addresses.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-OBFUSCATE_EMAILS = YES
-
-# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
-# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
-# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
-# the HTML output. These images will generally look nicer at scaled resolutions.
-# Possible values are: png (the default) and svg (looks nicer but requires the
-# pdf2svg or inkscape tool).
-# The default value is: png.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-HTML_FORMULA_FORMAT = png
-
-# Use this tag to change the font size of LaTeX formulas included as images in
-# the HTML documentation. When you change the font size after a successful
-# doxygen run you need to manually remove any form_*.png images from the HTML
-# output directory to force them to be regenerated.
-# Minimum value: 8, maximum value: 50, default value: 10.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-FORMULA_FONTSIZE = 14
-
-# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
-# to create new LaTeX commands to be used in formulas as building blocks. See
-# the section "Including formulas" for details.
-
-FORMULA_MACROFILE =
-
-# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
-# https://www.mathjax.org) which uses client side JavaScript for the rendering
-# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
-# installed or if you want to formulas look prettier in the HTML output. When
-# enabled you may also need to install MathJax separately and configure the path
-# to it using the MATHJAX_RELPATH option.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-USE_MATHJAX = YES
-
-# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
-# Note that the different versions of MathJax have different requirements with
-# regards to the different settings, so it is possible that also other MathJax
-# settings have to be changed when switching between the different MathJax
-# versions.
-# Possible values are: MathJax_2 and MathJax_3.
-# The default value is: MathJax_2.
-# This tag requires that the tag USE_MATHJAX is set to YES.
-
-MATHJAX_VERSION = MathJax_2
-
-# When MathJax is enabled you can set the default output format to be used for
-# the MathJax output. For more details about the output format see MathJax
-# version 2 (see:
-# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
-# (see:
-# http://docs.mathjax.org/en/latest/web/components/output.html).
-# Possible values are: HTML-CSS (which is slower, but has the best
-# compatibility. This is the name for Mathjax version 2, for MathJax version 3
-# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
-# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
-# is the name for Mathjax version 3, for MathJax version 2 this will be
-# translated into HTML-CSS) and SVG.
-# The default value is: HTML-CSS.
-# This tag requires that the tag USE_MATHJAX is set to YES.
-
-MATHJAX_FORMAT = HTML-CSS
-
-# When MathJax is enabled you need to specify the location relative to the HTML
-# output directory using the MATHJAX_RELPATH option. The destination directory
-# should contain the MathJax.js script. For instance, if the mathjax directory
-# is located at the same level as the HTML output directory, then
-# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
-# Content Delivery Network so you can quickly see the result without installing
-# MathJax. However, it is strongly recommended to install a local copy of
-# MathJax from https://www.mathjax.org before deployment. The default value is:
-# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
-# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
-# This tag requires that the tag USE_MATHJAX is set to YES.
-
-MATHJAX_RELPATH =
-
-# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
-# extension names that should be enabled during MathJax rendering. For example
-# for MathJax version 2 (see
-# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
-# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
-# For example for MathJax version 3 (see
-# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
-# MATHJAX_EXTENSIONS = ams
-# This tag requires that the tag USE_MATHJAX is set to YES.
-
-MATHJAX_EXTENSIONS =
-
-# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
-# of code that will be used on startup of the MathJax code. See the MathJax site
-# (see:
-# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
-# example see the documentation.
-# This tag requires that the tag USE_MATHJAX is set to YES.
-
-MATHJAX_CODEFILE =
-
-# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
-# the HTML output. The underlying search engine uses javascript and DHTML and
-# should work on any modern browser. Note that when using HTML help
-# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
-# there is already a search function so this one should typically be disabled.
-# For large projects the javascript based search engine can be slow, then
-# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
-# search using the keyboard; to jump to the search box use <access key> + S
-# (what the <access key> is depends on the OS and browser, but it is typically
-# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
-# key> to jump into the search results window, the results can be navigated
-# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
-# the search. The filter options can be selected when the cursor is inside the
-# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
-# to select a filter and <Enter> or <escape> to activate or cancel the filter
-# option.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_HTML is set to YES.
-
-SEARCHENGINE = YES
-
-# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
-# implemented using a web server instead of a web client using JavaScript. There
-# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
-# setting. When disabled, doxygen will generate a PHP script for searching and
-# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
-# and searching needs to be provided by external tools. See the section
-# "External Indexing and Searching" for details.
-# The default value is: NO.
-# This tag requires that the tag SEARCHENGINE is set to YES.
-
-SERVER_BASED_SEARCH = NO
-
-# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
-# script for searching. Instead the search results are written to an XML file
-# which needs to be processed by an external indexer. Doxygen will invoke an
-# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
-# search results.
-#
-# Doxygen ships with an example indexer (doxyindexer) and search engine
-# (doxysearch.cgi) which are based on the open source search engine library
-# Xapian (see:
-# https://xapian.org/).
-#
-# See the section "External Indexing and Searching" for details.
-# The default value is: NO.
-# This tag requires that the tag SEARCHENGINE is set to YES.
-
-EXTERNAL_SEARCH = NO
-
-# The SEARCHENGINE_URL should point to a search engine hosted by a web server
-# which will return the search results when EXTERNAL_SEARCH is enabled.
-#
-# Doxygen ships with an example indexer (doxyindexer) and search engine
-# (doxysearch.cgi) which are based on the open source search engine library
-# Xapian (see:
-# https://xapian.org/). See the section "External Indexing and Searching" for
-# details.
-# This tag requires that the tag SEARCHENGINE is set to YES.
-
-SEARCHENGINE_URL =
-
-# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
-# search data is written to a file for indexing by an external tool. With the
-# SEARCHDATA_FILE tag the name of this file can be specified.
-# The default file is: searchdata.xml.
-# This tag requires that the tag SEARCHENGINE is set to YES.
-
-SEARCHDATA_FILE = searchdata.xml
-
-# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
-# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
-# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
-# projects and redirect the results back to the right project.
-# This tag requires that the tag SEARCHENGINE is set to YES.
-
-EXTERNAL_SEARCH_ID =
-
-# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
-# projects other than the one defined by this configuration file, but that are
-# all added to the same external search index. Each project needs to have a
-# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
-# to a relative location where the documentation can be found. The format is:
-# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
-# This tag requires that the tag SEARCHENGINE is set to YES.
-
-EXTRA_SEARCH_MAPPINGS =
-
-#---------------------------------------------------------------------------
-# Configuration options related to the LaTeX output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
-# The default value is: YES.
-
-GENERATE_LATEX = NO
-
-# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
-# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
-# it.
-# The default directory is: latex.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_OUTPUT = latex
-
-# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
-# invoked.
-#
-# Note that when not enabling USE_PDFLATEX the default is latex when enabling
-# USE_PDFLATEX the default is pdflatex and when in the later case latex is
-# chosen this is overwritten by pdflatex. For specific output languages the
-# default can have been set differently, this depends on the implementation of
-# the output language.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_CMD_NAME =
-
-# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
-# index for LaTeX.
-# Note: This tag is used in the Makefile / make.bat.
-# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
-# (.tex).
-# The default file is: makeindex.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-MAKEINDEX_CMD_NAME = makeindex
-
-# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
-# generate index for LaTeX. In case there is no backslash (\) as first character
-# it will be automatically added in the LaTeX code.
-# Note: This tag is used in the generated output file (.tex).
-# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
-# The default value is: makeindex.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_MAKEINDEX_CMD = makeindex
-
-# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
-# documents. This may be useful for small projects and may help to save some
-# trees in general.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-COMPACT_LATEX = NO
-
-# The PAPER_TYPE tag can be used to set the paper type that is used by the
-# printer.
-# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
-# 14 inches) and executive (7.25 x 10.5 inches).
-# The default value is: a4.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-PAPER_TYPE = a4
-
-# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
-# that should be included in the LaTeX output. The package can be specified just
-# by its name or with the correct syntax as to be used with the LaTeX
-# \usepackage command. To get the times font for instance you can specify :
-# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
-# To use the option intlimits with the amsmath package you can specify:
-# EXTRA_PACKAGES=[intlimits]{amsmath}
-# If left blank no extra packages will be included.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-EXTRA_PACKAGES = amsmath
-
-# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
-# the generated LaTeX document. The header should contain everything until the
-# first chapter. If it is left blank doxygen will generate a standard header. It
-# is highly recommended to start with a default header using
-# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
-# and then modify the file new_header.tex. See also section "Doxygen usage" for
-# information on how to generate the default header that doxygen normally uses.
-#
-# Note: Only use a user-defined header if you know what you are doing!
-# Note: The header is subject to change so you typically have to regenerate the
-# default header when upgrading to a newer version of doxygen. The following
-# commands have a special meaning inside the header (and footer): For a
-# description of the possible markers and block names see the documentation.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_HEADER =
-
-# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
-# the generated LaTeX document. The footer should contain everything after the
-# last chapter. If it is left blank doxygen will generate a standard footer. See
-# LATEX_HEADER for more information on how to generate a default footer and what
-# special commands can be used inside the footer. See also section "Doxygen
-# usage" for information on how to generate the default footer that doxygen
-# normally uses. Note: Only use a user-defined footer if you know what you are
-# doing!
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_FOOTER =
-
-# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
-# LaTeX style sheets that are included after the standard style sheets created
-# by doxygen. Using this option one can overrule certain style aspects. Doxygen
-# will copy the style sheet files to the output directory.
-# Note: The order of the extra style sheet files is of importance (e.g. the last
-# style sheet in the list overrules the setting of the previous ones in the
-# list).
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_EXTRA_STYLESHEET =
-
-# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
-# other source files which should be copied to the LATEX_OUTPUT output
-# directory. Note that the files will be copied as-is; there are no commands or
-# markers available.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_EXTRA_FILES =
-
-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
-# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
-# contain links (just like the HTML output) instead of page references. This
-# makes the output suitable for online browsing using a PDF viewer.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-PDF_HYPERLINKS = YES
-
-# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
-# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
-# files. Set this option to YES, to get a higher quality PDF documentation.
-#
-# See also section LATEX_CMD_NAME for selecting the engine.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-USE_PDFLATEX = YES
-
-# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
-# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
-# mode nothing is printed on the terminal, errors are scrolled as if <return> is
-# hit at every error; missing files that TeX tries to input or request from
-# keyboard input (\read on a not open input stream) cause the job to abort,
-# NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
-# but there is no possibility of user interaction just like in batch mode,
-# SCROLL In scroll mode, TeX will stop only for missing files to input or if
-# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
-# each error, asking for user intervention.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_BATCHMODE = NO
-
-# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
-# index chapters (such as File Index, Compound Index, etc.) in the output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_HIDE_INDICES = NO
-
-# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
-# bibliography, e.g. plainnat, or ieeetr. See
-# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
-# The default value is: plain.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_BIB_STYLE = plain
-
-# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
-# path from which the emoji images will be read. If a relative path is entered,
-# it will be relative to the LATEX_OUTPUT directory. If left blank the
-# LATEX_OUTPUT directory will be used.
-# This tag requires that the tag GENERATE_LATEX is set to YES.
-
-LATEX_EMOJI_DIRECTORY =
-
-#---------------------------------------------------------------------------
-# Configuration options related to the RTF output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
-# RTF output is optimized for Word 97 and may not look too pretty with other RTF
-# readers/editors.
-# The default value is: NO.
-
-GENERATE_RTF = NO
-
-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
-# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
-# it.
-# The default directory is: rtf.
-# This tag requires that the tag GENERATE_RTF is set to YES.
-
-RTF_OUTPUT = rtf
-
-# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
-# documents. This may be useful for small projects and may help to save some
-# trees in general.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_RTF is set to YES.
-
-COMPACT_RTF = NO
-
-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
-# contain hyperlink fields. The RTF file will contain links (just like the HTML
-# output) instead of page references. This makes the output suitable for online
-# browsing using Word or some other Word compatible readers that support those
-# fields.
-#
-# Note: WordPad (write) and others do not support links.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_RTF is set to YES.
-
-RTF_HYPERLINKS = NO
-
-# Load stylesheet definitions from file. Syntax is similar to doxygen's
-# configuration file, i.e. a series of assignments. You only have to provide
-# replacements, missing definitions are set to their default value.
-#
-# See also section "Doxygen usage" for information on how to generate the
-# default style sheet that doxygen normally uses.
-# This tag requires that the tag GENERATE_RTF is set to YES.
-
-RTF_STYLESHEET_FILE =
-
-# Set optional variables used in the generation of an RTF document. Syntax is
-# similar to doxygen's configuration file. A template extensions file can be
-# generated using doxygen -e rtf extensionFile.
-# This tag requires that the tag GENERATE_RTF is set to YES.
-
-RTF_EXTENSIONS_FILE =
-
-#---------------------------------------------------------------------------
-# Configuration options related to the man page output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
-# classes and files.
-# The default value is: NO.
-
-GENERATE_MAN = NO
-
-# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
-# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
-# it. A directory man3 will be created inside the directory specified by
-# MAN_OUTPUT.
-# The default directory is: man.
-# This tag requires that the tag GENERATE_MAN is set to YES.
-
-MAN_OUTPUT = man
-
-# The MAN_EXTENSION tag determines the extension that is added to the generated
-# man pages. In case the manual section does not start with a number, the number
-# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
-# optional.
-# The default value is: .3.
-# This tag requires that the tag GENERATE_MAN is set to YES.
-
-MAN_EXTENSION = .3
-
-# The MAN_SUBDIR tag determines the name of the directory created within
-# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
-# MAN_EXTENSION with the initial . removed.
-# This tag requires that the tag GENERATE_MAN is set to YES.
-
-MAN_SUBDIR =
-
-# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
-# will generate one additional man file for each entity documented in the real
-# man page(s). These additional files only source the real man page, but without
-# them the man command would be unable to find the correct page.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_MAN is set to YES.
-
-MAN_LINKS = NO
-
-#---------------------------------------------------------------------------
-# Configuration options related to the XML output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
-# captures the structure of the code including all documentation.
-# The default value is: NO.
-
-GENERATE_XML = NO
-
-# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
-# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
-# it.
-# The default directory is: xml.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_OUTPUT = xml
-
-# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
-# listings (including syntax highlighting and cross-referencing information) to
-# the XML output. Note that enabling this will significantly increase the size
-# of the XML output.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_PROGRAMLISTING = YES
-
-# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
-# namespace members in file scope as well, matching the HTML output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_NS_MEMB_FILE_SCOPE = NO
-
-#---------------------------------------------------------------------------
-# Configuration options related to the DOCBOOK output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
-# that can be used to generate PDF.
-# The default value is: NO.
-
-GENERATE_DOCBOOK = NO
-
-# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
-# front of it.
-# The default directory is: docbook.
-# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
-
-DOCBOOK_OUTPUT = docbook
-
-#---------------------------------------------------------------------------
-# Configuration options for the AutoGen Definitions output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
-# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
-# the structure of the code including all documentation. Note that this feature
-# is still experimental and incomplete at the moment.
-# The default value is: NO.
-
-GENERATE_AUTOGEN_DEF = NO
-
-#---------------------------------------------------------------------------
-# Configuration options related to Sqlite3 output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
-# database with symbols found by doxygen stored in tables.
-# The default value is: NO.
-
-GENERATE_SQLITE3 = NO
-
-# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
-# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
-# in front of it.
-# The default directory is: sqlite3.
-# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
-
-SQLITE3_OUTPUT = sqlite3
-
-# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db
-# database file will be recreated with each doxygen run. If set to NO, doxygen
-# will warn if an a database file is already found and not modify it.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
-
-SQLITE3_RECREATE_DB = YES
-
-#---------------------------------------------------------------------------
-# Configuration options related to the Perl module output
-#---------------------------------------------------------------------------
-
-# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
-# file that captures the structure of the code including all documentation.
-#
-# Note that this feature is still experimental and incomplete at the moment.
-# The default value is: NO.
-
-GENERATE_PERLMOD = NO
-
-# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
-# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
-# output from the Perl module output.
-# The default value is: NO.
-# This tag requires that the tag GENERATE_PERLMOD is set to YES.
-
-PERLMOD_LATEX = NO
-
-# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
-# formatted so it can be parsed by a human reader. This is useful if you want to
-# understand what is going on. On the other hand, if this tag is set to NO, the
-# size of the Perl module output will be much smaller and Perl will parse it
-# just the same.
-# The default value is: YES.
-# This tag requires that the tag GENERATE_PERLMOD is set to YES.
-
-PERLMOD_PRETTY = YES
-
-# The names of the make variables in the generated doxyrules.make file are
-# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
-# so different doxyrules.make files included by the same Makefile don't
-# overwrite each other's variables.
-# This tag requires that the tag GENERATE_PERLMOD is set to YES.
-
-PERLMOD_MAKEVAR_PREFIX =
-
-#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor
-#---------------------------------------------------------------------------
-
-# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
-# C-preprocessor directives found in the sources and include files.
-# The default value is: YES.
-
-ENABLE_PREPROCESSING = YES
-
-# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
-# in the source code. If set to NO, only conditional compilation will be
-# performed. Macro expansion can be done in a controlled way by setting
-# EXPAND_ONLY_PREDEF to YES.
-# The default value is: NO.
-# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-
-MACRO_EXPANSION = NO
-
-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
-# the macro expansion is limited to the macros specified with the PREDEFINED and
-# EXPAND_AS_DEFINED tags.
-# The default value is: NO.
-# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-
-EXPAND_ONLY_PREDEF = NO
-
-# If the SEARCH_INCLUDES tag is set to YES, the include files in the
-# INCLUDE_PATH will be searched if a #include is found.
-# The default value is: YES.
-# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-
-SEARCH_INCLUDES = YES
-
-# The INCLUDE_PATH tag can be used to specify one or more directories that
-# contain include files that are not input files but should be processed by the
-# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
-# RECURSIVE has no effect here.
-# This tag requires that the tag SEARCH_INCLUDES is set to YES.
-
-INCLUDE_PATH =
-
-# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
-# patterns (like *.h and *.hpp) to filter out the header-files in the
-# directories. If left blank, the patterns specified with FILE_PATTERNS will be
-# used.
-# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-
-INCLUDE_FILE_PATTERNS =
-
-# The PREDEFINED tag can be used to specify one or more macro names that are
-# defined before the preprocessor is started (similar to the -D option of e.g.
-# gcc). The argument of the tag is a list of macros of the form: name or
-# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
-# is assumed. To prevent a macro definition from being undefined via #undef or
-# recursively expanded use the := operator instead of the = operator.
-# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-
-PREDEFINED =
-
-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
-# tag can be used to specify a list of macro names that should be expanded. The
-# macro definition that is found in the sources will be used. Use the PREDEFINED
-# tag if you want to use a different macro definition that overrules the
-# definition found in the source code.
-# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-
-EXPAND_AS_DEFINED =
-
-# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
-# remove all references to function-like macros that are alone on a line, have
-# an all uppercase name, and do not end with a semicolon. Such function macros
-# are typically used for boiler-plate code, and will confuse the parser if not
-# removed.
-# The default value is: YES.
-# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
-
-SKIP_FUNCTION_MACROS = YES
-
-#---------------------------------------------------------------------------
-# Configuration options related to external references
-#---------------------------------------------------------------------------
-
-# The TAGFILES tag can be used to specify one or more tag files. For each tag
-# file the location of the external documentation should be added. The format of
-# a tag file without this location is as follows:
-# TAGFILES = file1 file2 ...
-# Adding location for the tag files is done as follows:
-# TAGFILES = file1=loc1 "file2 = loc2" ...
-# where loc1 and loc2 can be relative or absolute paths or URLs. See the
-# section "Linking to external documentation" for more information about the use
-# of tag files.
-# Note: Each tag file must have a unique name (where the name does NOT include
-# the path). If a tag file is not located in the directory in which doxygen is
-# run, you must also specify the path to the tagfile here.
-
-TAGFILES =
-
-# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
-# tag file that is based on the input files it reads. See section "Linking to
-# external documentation" for more information about the usage of tag files.
-
-GENERATE_TAGFILE =
-
-# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
-# will be listed in the class and namespace index. If set to NO, only the
-# inherited external classes will be listed.
-# The default value is: NO.
-
-ALLEXTERNALS = NO
-
-# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
-# in the topic index. If set to NO, only the current project's groups will be
-# listed.
-# The default value is: YES.
-
-EXTERNAL_GROUPS = YES
-
-# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
-# the related pages index. If set to NO, only the current project's pages will
-# be listed.
-# The default value is: YES.
-
-EXTERNAL_PAGES = YES
-
-#---------------------------------------------------------------------------
-# Configuration options related to diagram generator tools
-#---------------------------------------------------------------------------
-
-# If set to YES the inheritance and collaboration graphs will hide inheritance
-# and usage relations if the target is undocumented or is not a class.
-# The default value is: YES.
-
-HIDE_UNDOC_RELATIONS = YES
-
-# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
-# available from the path. This tool is part of Graphviz (see:
-# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
-# Bell Labs. The other options in this section have no effect if this option is
-# set to NO
-# The default value is: NO.
-
-HAVE_DOT = NO
-
-# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
-# to run in parallel. When set to 0 doxygen will base this on the number of
-# processors available in the system. You can set it explicitly to a value
-# larger than 0 to get control over the balance between CPU load and processing
-# speed.
-# Minimum value: 0, maximum value: 32, default value: 0.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_NUM_THREADS = 0
-
-# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
-# subgraphs. When you want a differently looking font in the dot files that
-# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
-# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
-# Edge and Graph Attributes specification</a> You need to make sure dot is able
-# to find the font, which can be done by putting it in a standard location or by
-# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
-# directory containing the font. Default graphviz fontsize is 14.
-# The default value is: fontname=Helvetica,fontsize=10.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
-
-# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
-# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
-# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
-# arrows shapes.</a>
-# The default value is: labelfontname=Helvetica,labelfontsize=10.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
-
-# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
-# around nodes set 'shape=plain' or 'shape=plaintext' <a
-# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
-# The default value is: shape=box,height=0.2,width=0.4.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
-
-# You can set the path where dot can find font specified with fontname in
-# DOT_COMMON_ATTR and others dot attributes.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_FONTPATH =
-
-# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
-# generate a graph for each documented class showing the direct and indirect
-# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
-# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
-# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
-# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
-# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
-# relations will be shown as texts / links.
-# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
-# The default value is: YES.
-
-CLASS_GRAPH = YES
-
-# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
-# graph for each documented class showing the direct and indirect implementation
-# dependencies (inheritance, containment, and class references variables) of the
-# class with other documented classes. Explicit enabling a collaboration graph,
-# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
-# command \collaborationgraph. Disabling a collaboration graph can be
-# accomplished by means of the command \hidecollaborationgraph.
-# The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-COLLABORATION_GRAPH = YES
-
-# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
-# groups, showing the direct groups dependencies. Explicit enabling a group
-# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
-# of the command \groupgraph. Disabling a directory graph can be accomplished by
-# means of the command \hidegroupgraph. See also the chapter Grouping in the
-# manual.
-# The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-GROUP_GRAPHS = YES
-
-# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
-# collaboration diagrams in a style similar to the OMG's Unified Modeling
-# Language.
-# The default value is: NO.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-UML_LOOK = NO
-
-# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
-# class node. If there are many fields or methods and many nodes the graph may
-# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
-# number of items for each type to make the size more manageable. Set this to 0
-# for no limit. Note that the threshold may be exceeded by 50% before the limit
-# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
-# but if the number exceeds 15, the total amount of fields shown is limited to
-# 10.
-# Minimum value: 0, maximum value: 100, default value: 10.
-# This tag requires that the tag UML_LOOK is set to YES.
-
-UML_LIMIT_NUM_FIELDS = 10
-
-# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
-# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
-# tag is set to YES, doxygen will add type and arguments for attributes and
-# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
-# will not generate fields with class member information in the UML graphs. The
-# class diagrams will look similar to the default class diagrams but using UML
-# notation for the relationships.
-# Possible values are: NO, YES and NONE.
-# The default value is: NO.
-# This tag requires that the tag UML_LOOK is set to YES.
-
-DOT_UML_DETAILS = NO
-
-# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
-# to display on a single line. If the actual line length exceeds this threshold
-# significantly it will wrapped across multiple lines. Some heuristics are apply
-# to avoid ugly line breaks.
-# Minimum value: 0, maximum value: 1000, default value: 17.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_WRAP_THRESHOLD = 17
-
-# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
-# collaboration graphs will show the relations between templates and their
-# instances.
-# The default value is: NO.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-TEMPLATE_RELATIONS = NO
-
-# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
-# YES then doxygen will generate a graph for each documented file showing the
-# direct and indirect include dependencies of the file with other documented
-# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
-# can be accomplished by means of the command \includegraph. Disabling an
-# include graph can be accomplished by means of the command \hideincludegraph.
-# The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-INCLUDE_GRAPH = YES
-
-# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
-# set to YES then doxygen will generate a graph for each documented file showing
-# the direct and indirect include dependencies of the file with other documented
-# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
-# to NO, can be accomplished by means of the command \includedbygraph. Disabling
-# an included by graph can be accomplished by means of the command
-# \hideincludedbygraph.
-# The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-INCLUDED_BY_GRAPH = YES
-
-# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
-# dependency graph for every global function or class method.
-#
-# Note that enabling this option will significantly increase the time of a run.
-# So in most cases it will be better to enable call graphs for selected
-# functions only using the \callgraph command. Disabling a call graph can be
-# accomplished by means of the command \hidecallgraph.
-# The default value is: NO.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-CALL_GRAPH = NO
-
-# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
-# dependency graph for every global function or class method.
-#
-# Note that enabling this option will significantly increase the time of a run.
-# So in most cases it will be better to enable caller graphs for selected
-# functions only using the \callergraph command. Disabling a caller graph can be
-# accomplished by means of the command \hidecallergraph.
-# The default value is: NO.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-CALLER_GRAPH = NO
-
-# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
-# hierarchy of all classes instead of a textual one.
-# The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-GRAPHICAL_HIERARCHY = YES
-
-# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
-# dependencies a directory has on other directories in a graphical way. The
-# dependency relations are determined by the #include relations between the
-# files in the directories. Explicit enabling a directory graph, when
-# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
-# \directorygraph. Disabling a directory graph can be accomplished by means of
-# the command \hidedirectorygraph.
-# The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DIRECTORY_GRAPH = YES
-
-# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
-# of child directories generated in directory dependency graphs by dot.
-# Minimum value: 1, maximum value: 25, default value: 1.
-# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
-
-DIR_GRAPH_MAX_DEPTH = 1
-
-# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
-# generated by dot. For an explanation of the image formats see the section
-# output formats in the documentation of the dot tool (Graphviz (see:
-# https://www.graphviz.org/)).
-# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
-# to make the SVG files visible in IE 9+ (other browsers do not have this
-# requirement).
-# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
-# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
-# png:gdiplus:gdiplus.
-# The default value is: png.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_IMAGE_FORMAT = png
-
-# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
-# enable generation of interactive SVG images that allow zooming and panning.
-#
-# Note that this requires a modern browser other than Internet Explorer. Tested
-# and working are Firefox, Chrome, Safari, and Opera.
-# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
-# the SVG files visible. Older versions of IE do not have SVG support.
-# The default value is: NO.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-INTERACTIVE_SVG = NO
-
-# The DOT_PATH tag can be used to specify the path where the dot tool can be
-# found. If left blank, it is assumed the dot tool can be found in the path.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_PATH =
-
-# The DOTFILE_DIRS tag can be used to specify one or more directories that
-# contain dot files that are included in the documentation (see the \dotfile
-# command).
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOTFILE_DIRS =
-
-# You can include diagrams made with dia in doxygen documentation. Doxygen will
-# then run dia to produce the diagram and insert it in the documentation. The
-# DIA_PATH tag allows you to specify the directory where the dia binary resides.
-# If left empty dia is assumed to be found in the default search path.
-
-DIA_PATH =
-
-# The DIAFILE_DIRS tag can be used to specify one or more directories that
-# contain dia files that are included in the documentation (see the \diafile
-# command).
-
-DIAFILE_DIRS =
-
-# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
-# path where java can find the plantuml.jar file or to the filename of jar file
-# to be used. If left blank, it is assumed PlantUML is not used or called during
-# a preprocessing step. Doxygen will generate a warning when it encounters a
-# \startuml command in this case and will not generate output for the diagram.
-
-PLANTUML_JAR_PATH =
-
-# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
-# configuration file for plantuml.
-
-PLANTUML_CFG_FILE =
-
-# When using plantuml, the specified paths are searched for files specified by
-# the !include statement in a plantuml block.
-
-PLANTUML_INCLUDE_PATH =
-
-# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
-# that will be shown in the graph. If the number of nodes in a graph becomes
-# larger than this value, doxygen will truncate the graph, which is visualized
-# by representing a node as a red box. Note that doxygen if the number of direct
-# children of the root node in a graph is already larger than
-# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
-# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
-# Minimum value: 0, maximum value: 10000, default value: 50.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_GRAPH_MAX_NODES = 50
-
-# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
-# generated by dot. A depth value of 3 means that only nodes reachable from the
-# root by following a path via at most 3 edges will be shown. Nodes that lay
-# further from the root node will be omitted. Note that setting this option to 1
-# or 2 may greatly reduce the computation time needed for large code bases. Also
-# note that the size of a graph can be further restricted by
-# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
-# Minimum value: 0, maximum value: 1000, default value: 0.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-MAX_DOT_GRAPH_DEPTH = 0
-
-# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
-# files in one run (i.e. multiple -o and -T options on the command line). This
-# makes dot run faster, but since only newer versions of dot (>1.8.10) support
-# this, this feature is disabled by default.
-# The default value is: NO.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-DOT_MULTI_TARGETS = NO
-
-# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
-# explaining the meaning of the various boxes and arrows in the dot generated
-# graphs.
-# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
-# graphical representation for inheritance and collaboration diagrams is used.
-# The default value is: YES.
-# This tag requires that the tag HAVE_DOT is set to YES.
-
-GENERATE_LEGEND = YES
-
-# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
-# files that are used to generate the various graphs.
-#
-# Note: This setting is not only used for dot files but also for msc temporary
-# files.
-# The default value is: YES.
-
-DOT_CLEANUP = YES
-
-# You can define message sequence charts within doxygen comments using the \msc
-# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
-# use a built-in version of mscgen tool to produce the charts. Alternatively,
-# the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
-# specifying prog as the value, doxygen will call the tool as prog -T
-# <outfile_format> -o <outputfile> <inputfile>. The external tool should support
-# output file formats "png", "eps", "svg", and "ismap".
-
-MSCGEN_TOOL =
-
-# The MSCFILE_DIRS tag can be used to specify one or more directories that
-# contain msc files that are included in the documentation (see the \mscfile
-# command).
-
-MSCFILE_DIRS =
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/DoxygenLayout.xml b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/DoxygenLayout.xml
deleted file mode 100644
index dfdd003..0000000
--- a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/DoxygenLayout.xml
+++ /dev/null
@@ -1,242 +0,0 @@
-<doxygenlayout version="1.0">
- <!-- Generated by doxygen 1.9.7 -->
- <!-- Navigation index tabs for HTML output -->
- <navindex>
- <tab type="mainpage" visible="yes" title="Home"/>
- <!-- <tab type="user" url="md_content_2mypage.html" title="Getting Started"/> -->
- <tab type="pages" visible="yes" title="" intro=""/>
- <tab type="modules" visible="yes" title="" intro=""/>
- <tab type="namespaces" visible="yes" title="">
- <tab type="namespacelist" visible="yes" title="" intro=""/>
- <tab type="namespacemembers" visible="yes" title="" intro=""/>
- </tab>
- <tab type="concepts" visible="yes" title="">
- </tab>
- <tab type="interfaces" visible="yes" title="">
- <tab type="interfacelist" visible="yes" title="" intro=""/>
- <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
- <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
- </tab>
- <tab type="classes" visible="yes" title="">
- <tab type="classlist" visible="yes" title="" intro=""/>
- <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
- <tab type="hierarchy" visible="yes" title="" intro=""/>
- <tab type="classmembers" visible="yes" title="" intro=""/>
- </tab>
- <tab type="structs" visible="yes" title="">
- <tab type="structlist" visible="yes" title="" intro=""/>
- <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
- </tab>
- <tab type="exceptions" visible="yes" title="">
- <tab type="exceptionlist" visible="yes" title="" intro=""/>
- <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
- <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
- </tab>
- <tab type="files" visible="yes" title="">
- <tab type="filelist" visible="yes" title="" intro=""/>
- <tab type="globals" visible="yes" title="" intro=""/>
- </tab>
- <tab type="examples" visible="yes" title="" intro=""/>
- <tab type="user" url="https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/modules/overview/" title="Module Overview" />
- </navindex>
-
- <!-- Layout definition for a class page -->
- <class>
- <briefdescription visible="yes"/>
- <includes visible="$SHOW_HEADERFILE"/>
- <inheritancegraph visible="$CLASS_GRAPH"/>
- <collaborationgraph visible="$COLLABORATION_GRAPH"/>
- <memberdecl>
- <nestedclasses visible="yes" title=""/>
- <publictypes title=""/>
- <services title=""/>
- <interfaces title=""/>
- <publicslots title=""/>
- <signals title=""/>
- <publicmethods title=""/>
- <publicstaticmethods title=""/>
- <publicattributes title=""/>
- <publicstaticattributes title=""/>
- <protectedtypes title=""/>
- <protectedslots title=""/>
- <protectedmethods title=""/>
- <protectedstaticmethods title=""/>
- <protectedattributes title=""/>
- <protectedstaticattributes title=""/>
- <packagetypes title=""/>
- <packagemethods title=""/>
- <packagestaticmethods title=""/>
- <packageattributes title=""/>
- <packagestaticattributes title=""/>
- <properties title=""/>
- <events title=""/>
- <privatetypes title=""/>
- <privateslots title=""/>
- <privatemethods title=""/>
- <privatestaticmethods title=""/>
- <privateattributes title=""/>
- <privatestaticattributes title=""/>
- <friends title=""/>
- <related title="" subtitle=""/>
- <membergroups visible="yes"/>
- </memberdecl>
- <detaileddescription title=""/>
- <memberdef>
- <inlineclasses title=""/>
- <typedefs title=""/>
- <enums title=""/>
- <services title=""/>
- <interfaces title=""/>
- <constructors title=""/>
- <functions title=""/>
- <related title=""/>
- <variables title=""/>
- <properties title=""/>
- <events title=""/>
- </memberdef>
- <allmemberslink visible="yes"/>
- <usedfiles visible="$SHOW_USED_FILES"/>
- <authorsection visible="yes"/>
- </class>
-
- <!-- Layout definition for a namespace page -->
- <namespace>
- <briefdescription visible="yes"/>
- <memberdecl>
- <nestednamespaces visible="yes" title=""/>
- <constantgroups visible="yes" title=""/>
- <interfaces visible="yes" title=""/>
- <classes visible="yes" title=""/>
- <concepts visible="yes" title=""/>
- <structs visible="yes" title=""/>
- <exceptions visible="yes" title=""/>
- <typedefs title=""/>
- <sequences title=""/>
- <dictionaries title=""/>
- <enums title=""/>
- <functions title=""/>
- <variables title=""/>
- <membergroups visible="yes"/>
- </memberdecl>
- <detaileddescription title=""/>
- <memberdef>
- <inlineclasses title=""/>
- <typedefs title=""/>
- <sequences title=""/>
- <dictionaries title=""/>
- <enums title=""/>
- <functions title=""/>
- <variables title=""/>
- </memberdef>
- <authorsection visible="yes"/>
- </namespace>
-
- <!-- Layout definition for a concept page -->
- <concept>
- <briefdescription visible="yes"/>
- <includes visible="$SHOW_HEADERFILE"/>
- <definition visible="yes" title=""/>
- <detaileddescription title=""/>
- <authorsection visible="yes"/>
- </concept>
-
- <!-- Layout definition for a file page -->
- <file>
- <briefdescription visible="yes"/>
- <includes visible="$SHOW_INCLUDE_FILES"/>
- <includegraph visible="$INCLUDE_GRAPH"/>
- <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
- <sourcelink visible="yes"/>
- <memberdecl>
- <interfaces visible="yes" title=""/>
- <classes visible="yes" title=""/>
- <structs visible="yes" title=""/>
- <exceptions visible="yes" title=""/>
- <namespaces visible="yes" title=""/>
- <concepts visible="yes" title=""/>
- <constantgroups visible="yes" title=""/>
- <defines title=""/>
- <typedefs title=""/>
- <sequences title=""/>
- <dictionaries title=""/>
- <enums title=""/>
- <functions title=""/>
- <variables title=""/>
- <membergroups visible="yes"/>
- </memberdecl>
- <detaileddescription title=""/>
- <memberdef>
- <inlineclasses title=""/>
- <defines title=""/>
- <typedefs title=""/>
- <sequences title=""/>
- <dictionaries title=""/>
- <enums title=""/>
- <functions title=""/>
- <variables title=""/>
- </memberdef>
- <authorsection/>
- </file>
-
- <!-- Layout definition for a group page -->
- <group>
- <briefdescription visible="yes"/>
- <groupgraph visible="$GROUP_GRAPHS"/>
- <memberdecl>
- <nestedgroups visible="yes" title=""/>
- <dirs visible="yes" title=""/>
- <files visible="yes" title=""/>
- <namespaces visible="yes" title=""/>
- <concepts visible="yes" title=""/>
- <classes visible="yes" title=""/>
- <defines title=""/>
- <typedefs title=""/>
- <sequences title=""/>
- <dictionaries title=""/>
- <enums title=""/>
- <enumvalues title=""/>
- <functions title=""/>
- <variables title=""/>
- <signals title=""/>
- <publicslots title=""/>
- <protectedslots title=""/>
- <privateslots title=""/>
- <events title=""/>
- <properties title=""/>
- <friends title=""/>
- <membergroups visible="yes"/>
- </memberdecl>
- <detaileddescription title=""/>
- <memberdef>
- <pagedocs/>
- <inlineclasses title=""/>
- <defines title=""/>
- <typedefs title=""/>
- <sequences title=""/>
- <dictionaries title=""/>
- <enums title=""/>
- <enumvalues title=""/>
- <functions title=""/>
- <variables title=""/>
- <signals title=""/>
- <publicslots title=""/>
- <protectedslots title=""/>
- <privateslots title=""/>
- <events title=""/>
- <properties title=""/>
- <friends title=""/>
- </memberdef>
- <authorsection visible="yes"/>
- </group>
-
- <!-- Layout definition for a directory page -->
- <directory>
- <briefdescription visible="yes"/>
- <directorygraph visible="yes"/>
- <memberdecl>
- <dirs visible="yes"/>
- <files visible="yes"/>
- </memberdecl>
- <detaileddescription title=""/>
- </directory>
-</doxygenlayout>
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/getting_started.md b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/getting_started.md
deleted file mode 100644
index 7152c11..0000000
--- a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/getting_started.md
+++ /dev/null
@@ -1,339 +0,0 @@
-# Getting started
-This guide will show you the basic usage of _cost_estimation_. The following steps are necessary (if you are new to UNICADO check out the [settings and outputs](#settingsandoutputs) first!).
-
-## Step-by-step
-It is assumed that you have the `UNICADO package` installed including the executables. In case you are a developer, you need to build the tool first (see [build instructions on UNICADO website](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/build/general/))
-
-
-Execute the following steps to run the module:
-1. Create a dummy `aircraft_exchange_file` (minimal required input see [here](#acXML))
-2. Fill out the `cost_estimation_conf.xml` - change at least:
- - in the `control_settings` block
- - `aircraft_exchange_file_name` and `aircraft_exchange_file_directory` to your respective settings
- - `console_output` at least to `mode_1`
- - `plot_output` to false (or define `inkscape_path` and `gnuplot_path`)
- - in `program_settings`
- - ...
-3. Open terminal and run `cost_estimation`
-
-The following will happen:
-- You see output in the console window
-- A HTML report is created in the directory of the aircraft exchange file (no plots are generated if they are turned off)
-- Results are saved in the aircraft exchange file at the `aircraft_exchange_file/assessment/cost_estimation/operating_cost` node
-
-@note The dummy does not include any aircraft data. Therefore the cost estimation will not work and warnings are expected in the output.
-
-## Settings and outputs {#settingsandoutputs}
-Generally, we use two files to set or configure in UNICADO:
-- the aircraft exchange file (or _acXML_) includes
- - data related inputs (e.g., aircraft configuration, transport task)
- - data related outputs (e.g., annual direct operating costs)
-- the configuration file `cost_estimation_conf.xml` (also _configXML_) includes
- - control settings (e.g., enable/disable generating plots)
- - program settings (e.g., fees, usage information)
-
-### Aircraft exchange file
-@note The _acXML_ is an exchange file - we agreed on that only data will be saved as output that is needed by another tool!
-
-#### Inputs
-The following information is needed from the _acXML_:
-1. Design specification
- 1. Configuration information: Configuration type
- 2. Transport task: Passenger definition, passenger class definition, and cargo definition
- 3. Energy carriers
-2. Top level aircraft requirements (for design and study mission - if desired)
- 1. Initial cruise mach number
- 2. Initial cruise altitude
- 3. Payload fractions (seat load factor, only required for study mission assessment)
-3. Component design
- 1. Fuselage: Number of required cabin crew
- 2. Propulsion: Sea level static thrust per engine
-4. Analysis
- 1. Masses: Maximum takeoff mass (certified), operating mass empty, maximum payload mass
- 2. Mission (for design and study mission - if desired)
- - Range
- - Flight time
- - Payload mass
- - Number of passengers
- - Number of flight crew
- - Cargo mass
- - Takeoff mass
-5. Assessment (aka. payload range data)
- 1. Range at maximum payload and fuel mass till maximum take off mass limit
- 2. Range at full tanks and payload till maximum take off mass limit
- 3. Range for no payload and full tanks (ferry range)
- 4. Payload at full tanks and payload till maximum take off mass limit
-
-#### Outputs
-The essential results are saved in the _acXML_ node `aircraft_exchange_file/assessment/cost_estimation/operating_cost/direct_operating_cost`.
-When implemented, the indirect operating costs are going to be saved at `aircraft_exchange_file/assessment/cost_estimation/operating_cost/indirect_operating_cost`.
-
-```plaintext
-Direct operating cost
-|- Route independent cost annual
-|- Route dependent cost annual
-|- Direct operating cost annual
-```
-
-Further information can be extracted from the additional output file.
-
-### Configuration file
-The control settings are standardized in UNICADO and will not be described in detail here. The program settings are structured like this (descriptions are in the `cost_estimation_conf.xml`):
-
-```plaintext
-Program Settings
-|- Configuration (ID="tube_and_wing")
-| |- Fidelity name
-| |- Method name
-| |- Fidelity (ID="empirical")
-| | |- Operating cost estimation tu berlin
-| | | |- General direct operating costs parameter
-| | | | | - Capital
-| | | | | | - Depreciation period
-| | | | | | - Price per operating empty mass
-| | | | | | - Rate insurance
-| | | | | | - Rate interest
-| | | | | | - Residual value factor
-| | | | | - Crew
-| | | | | | - Salary variation
-| | | | | - Flight cycles
-| | | | | | - Block time per flight
-| | | | | | - Daily night curfew time
-| | | | | | - Potential annual operation time
-| | | | | | - Annual lay days overhaul
-| | | | | | - Annual lay days reserve
-| | | | | | - Annual lay days maintenance
-| | | | | - Handling
-| | | | | | - Fees handling
-| | | | | - Landing
-| | | | | | - Fees landing
-| | | | | - Air traffic control
-| | | | | | - Air traffic control price factor design
-| | | | | | - Air traffic control price factor study
-| | | | | - Maintenance
-| | | | | | - Airframe repair cost per flight
-| | | | | | - Cost burden
-| | | | | | - Rate labor
-| | | | | - Related direct operating costs
-| | | | | | - Revenue per freight km design
-| | | | | | - Revenue per freight km study
-| | | | | - Miscellaneous
-| | | | | | - Rate inflation
-| | | |- Fuel type (ID="kerosene")
-| | | | | - Factor engine maintenance
-| | | | | - Fuel price
-| | | | | - Ratio operating empty mass
-| | | |- Fuel type (ID="liquid_hydrogen")
-| | | | | - Factor engine maintenance
-| | | | | - Fuel price
-| | | | | - Ratio operating empty mass
-```
-
-## Minimal required aircraft exchange file input {#acXML}
-As the _cost_estimation_ tool is part of the assessment modules in UNICADO, it is based on the assumption that a converged design and a correspondingly complete _acXML_ file are already available. The following parameters are required to generate results with the tool.
-
-```xml
-<aircraft_exchange_file>
- <requirements_and_specifications description="Requirements and specifications">
- <design_specification description="Design specification">
- <configuration description="Configuration information">
- <configuration_type description="aircraft configuration: tube_and_wing / blended_wing_body">
- <value>tube_and_wing</value>
- </configuration_type>
- </configuration>
- <transport_task>
- <passenger_definition description="Define the masses of the passengers">
- <mass_per_passenger description="Design mass of a single passenger WITHOUT luggage">
- <value>80</value>
- <unit>kg</unit>
- <lower_boundary>50</lower_boundary>
- <upper_boundary>200</upper_boundary>
- </mass_per_passenger>
- <luggage_mass_per_passenger description="Design mass of a the luggage for a single passenger">
- <value>17</value>
- <unit>kg</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>25</upper_boundary>
- </luggage_mass_per_passenger>
- </passenger_definition>
- <passenger_class_definition>
- <class_distribution description="Relative passenger distribution for the classes: President Class/First Class/Business Class/Premium Economy/Economy. Sum must be equal to 1!">
- <value>0/0/0/0.1/0.9</value>
- </class_distribution>
- </passenger_class_definition>
- <cargo_definition description="Definition of cargo which does not belong to passengers">
- <additional_cargo_mass description="Mass of cargo which does not belong to passengers">
- <value>500</value>
- <unit>kg</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1000</upper_boundary>
- </additional_cargo_mass>
- <cargo_density description="Density of cargo which does not belong to passengers">
- <value>165</value>
- <unit>kg/m^3</unit>
- <lower_boundary>150</lower_boundary>
- <upper_boundary>200</upper_boundary>
- </cargo_density>
- </cargo_definition>
- </transport_task>
- <energy_carriers description="Energy carriers information">
- <energy_carrier ID="0" description="One specific energy carrier">
- <type description="Energy type: kerosene / liquid_hydrogen / battery / saf (for multifuel engine create new ID)">
- <value>kerosene</value>
- </type>
- </energy_carrier>
- </energy_carriers>
- </design_specification>
- <requirements description="Aircraft design requirements">
- <top_level_aircraft_requirements description="Top level aircraft requirements (TLAR)">
- <design_mission description="Requirements regarding the design mission">
- <initial_cruise_mach_number description="Initial cruise Mach number at top of descent. May be altered during cruise.">
- <value>0.78</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1</upper_boundary>
- </initial_cruise_mach_number>
- <initial_cruise_altitude description="Initial cruise altitude (ICA) at top of descent. May be altered during cruise.">
- <value>10058.4</value>
- <unit>m</unit>
- <lower_boundary>1000</lower_boundary>
- <upper_boundary>20000</upper_boundary>
- </initial_cruise_altitude>
- </design_mission>
- </top_level_aircraft_requirements>
- </requirements>
- </requirements_and_specifications>
- <component_design>
- <fuselage description="Geometric description of the aircraft fuselage." tool_level="1">
- <specific description="Fuselage design specific output parameter.">
- <geometry description="Geometry description of the entire fuselage design.">
- <fuselage ID="0" description="Geometrical description of one entire fuselage.">
- <number_of_required_cabin_crew description="Number of minimum required flight attendants.">
- <value>4</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>100</upper_boundary>
- </number_of_required_cabin_crew>
- </fuselage>
- </geometry>
- </specific>
- </fuselage>
- <propulsion>
- <specific>
- <propulsion ID="0" description="Description of one propulsion">
- <engine>
- <SLST description="Sea level static thrust of the engine">
- <value>109167.0872</value>
- <unit>N</unit>
- <lower_boundary>-1.797693135e+308</lower_boundary>
- <upper_boundary>1.797693135e+308</upper_boundary>
- </SLST>
- </engine>
- </propulsion>
- </specific>
- </propulsion>
- </component_design>
- <analysis>
- <masses_cg_inertia>
- <maximum_takeoff_mass>
- <mass_properties>
- <mass description="mass">
- <value>66042.62842</value>
- <unit>kg</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </maximum_takeoff_mass>
- <operating_mass_empty>
- <mass_properties>
- <mass description="mass">
- <value>36209.43617</value>
- <unit>kg</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>300000</upper_boundary>
- </mass>
- </mass_properties>
- </operating_mass_empty>
- <maximum_payload_mass>
- <mass_properties>
- <mass description="mass">
- <value>66042.62842</value>
- <unit>kg</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </mass>
- </mass_properties>
- </maximum_payload_mass>
- </masses_cg_inertia>
- <mission description="Mission data." tool_level="0">
- <design_mission description="Data of design mission">
- <range description="Traveled range from break release to end of taxi at destination">
- <value>0</value>
- <unit>m</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>5000000</upper_boundary>
- </range>
- <flight_time description="Flight time for the whole mission">
- <value>0</value>
- <unit>s</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>44500</upper_boundary>
- </flight_time>
- <payload_mass description="Total payload carried by the aircraft">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>150000</upper_boundary>
- </payload_mass>
- <number_of_pax description="Number of passengers for the mission">
- <value>0</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>1000</upper_boundary>
- </number_of_pax>
- <number_of_flight_crew description="Number of flight crew member for the mission">
- <value>0</value>
- <unit>1</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>10</upper_boundary>
- </number_of_flight_crew>
- <cargo_mass description="Cargo mass">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>inf</upper_boundary>
- </cargo_mass>
- <takeoff_mass description="Takeoff mass">
- <value>0</value>
- <unit>kg</unit>
- <lower_boundary>0</lower_boundary>
- <upper_boundary>150000</upper_boundary>
- </takeoff_mass>
- </design_mission>
- </mission>
- </analysis>
- <assessment>
- <performance description="Assessment of performance values">
- <range tool_level="0">
- <range_max_payload_at_maximum_takeoff_mass description="Range at maximum payload and fuel mass till maximum take off mass limit">
- <value>0</value>
- <unit>m</unit>
- </range_max_payload_at_maximum_takeoff_mass>
- <range_max_fuel_at_maximum_takeoff_mass description="Range at full tanks and payload till maximum take off mass limit">
- <value>0</value>
- <unit>m</unit>
- </range_max_fuel_at_maximum_takeoff_mass>
- <payload_maximum_fuel_at_maximum_takeoff_mass description="Payload at full tanks and payload till maximum take off mass limit">
- <value>0</value>
- <unit>kg</unit>
- </payload_maximum_fuel_at_maximum_takeoff_mass>
- <range_maximum_fuel_empty description="Range for no payload and full tanks">
- <value>0</value>
- <unit>m</unit>
- </range_maximum_fuel_empty>
- </range>
- </performance>
- </assessment>
-</aircraft_exchange_file>
-```
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/index.md b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/index.md
deleted file mode 100644
index 2191696..0000000
--- a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/index.md
+++ /dev/null
@@ -1,16 +0,0 @@
-# Introduction {#mainpage}
-Welcome to the _cost_estimation_ module in UNICADO. [...]
-
-## Summary of features
-Here’s a quick rundown of what the tool currently does, along with a sneak peek at what's planned:
-
- Configuration | Fidelity | Method(s) | Energy carrier |Cost share | Status |
-------------------|-----------|-----------|-----------------|-------------------------|:------------------------------:|
-Tube-and-wing |Empirical |TU Berlin |Kerosene |Direct operating cost |running \emoji white_check_mark |
-Tube-and-wing |Empirical |TU Berlin |Kerosene |Indirect operating cost |missing \emoji construction |
-Tube-and-wing |Empirical |TU Berlin |Liquid hydrogen |Direct operating cost |running \emoji white_check_mark |
-Tube-and-wing |Empirical |TU Berlin |Liquid hydrogen |Indirect operating cost |missing \emoji construction |
-Blended-wing-body |... |... |... |... |missing \emoji construction |
-
-## Ready for takeoff
-The [getting started page](getting_started.md) provides an initial understanding of how to execute the tool and its fundamental operations. For a comprehensive understanding of the tool’s functionality, the documentation is structured into two distinct sections: a [method description](operating_cost_method.md) and a [software architecture](software_architecture.md) section.
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/operating_cost_method.md b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/operating_cost_method.md
deleted file mode 100644
index 1ba8cef..0000000
--- a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/operating_cost_method.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# Calculation method
-
-Add method description here...
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/software_architecture.md b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/software_architecture.md
deleted file mode 100644
index e02b42f..0000000
--- a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/content/software_architecture.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# Software architecture
-Add information on software architecture here.
\ No newline at end of file
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/header.html b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/header.html
deleted file mode 100644
index 92af47f..0000000
--- a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/doc/header.html
+++ /dev/null
@@ -1,86 +0,0 @@
-<!-- HTML header for doxygen 1.9.8-->
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<meta http-equiv="X-UA-Compatible" content="IE=11"/>
-<meta name="generator" content="Doxygen $doxygenversion"/>
-<meta name="viewport" content="width=device-width, initial-scale=1"/>
-<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
-<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
-<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
-<!--BEGIN DISABLE_INDEX-->
- <!--BEGIN FULL_SIDEBAR-->
-<script type="text/javascript">var page_layout=1;</script>
- <!--END FULL_SIDEBAR-->
-<!--END DISABLE_INDEX-->
-<script type="text/javascript" src="$relpath^jquery.js"></script>
-<script type="text/javascript" src="$relpath^dynsections.js"></script>
-<script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
-<script type="text/javascript">
- DoxygenAwesomeDarkModeToggle.init()
-</script>
-<script type="text/javascript" src="$relpath^doxygen-awesome-tabs.js"></script>
-<script type="text/javascript">
- DoxygenAwesomeTabs.init()
-</script>
-<script type="text/javascript" src="$relpath^doxygen-awesome-fragment-copy-button.js"></script>
-<script type="text/javascript">
- DoxygenAwesomeFragmentCopyButton.init()
-</script>
-$treeview
-$search
-$mathjax
-$darkmode
-<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
-$extrastylesheet
-</head>
-<body>
-<!--BEGIN DISABLE_INDEX-->
- <!--BEGIN FULL_SIDEBAR-->
-<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
- <!--END FULL_SIDEBAR-->
-<!--END DISABLE_INDEX-->
-
-<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-
-<!--BEGIN TITLEAREA-->
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <!--BEGIN PROJECT_LOGO-->
- <td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
- <!--END PROJECT_LOGO-->
- <!--BEGIN PROJECT_NAME-->
- <td id="projectalign">
- <div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber"> $projectnumber</span><!--END PROJECT_NUMBER-->
- </div>
- <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
- </td>
- <!--END PROJECT_NAME-->
- <!--BEGIN !PROJECT_NAME-->
- <!--BEGIN PROJECT_BRIEF-->
- <td>
- <div id="projectbrief">$projectbrief</div>
- </td>
- <!--END PROJECT_BRIEF-->
- <!--END !PROJECT_NAME-->
- <!--BEGIN DISABLE_INDEX-->
- <!--BEGIN SEARCHENGINE-->
- <!--BEGIN !FULL_SIDEBAR-->
- <td>$searchbox</td>
- <!--END !FULL_SIDEBAR-->
- <!--END SEARCHENGINE-->
- <!--END DISABLE_INDEX-->
- </tr>
- <!--BEGIN SEARCHENGINE-->
- <!--BEGIN FULL_SIDEBAR-->
- <tr><td colspan="2">$searchbox</td></tr>
- <!--END FULL_SIDEBAR-->
- <!--END SEARCHENGINE-->
- </tbody>
-</table>
-</div>
-<!--END TITLEAREA-->
-<!-- end header part -->
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/Icon\r"
deleted file mode 100644
index e69de29..0000000
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/blended_wing_body/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/blended_wing_body/Icon\r"
deleted file mode 100644
index e69de29..0000000
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/Icon\r"
deleted file mode 100644
index e69de29..0000000
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/Icon\r"
deleted file mode 100644
index e69de29..0000000
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/Icon\r"
deleted file mode 100644
index e69de29..0000000
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/general/Icon\r"
deleted file mode 100644
index e69de29..0000000
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/Icon\r"
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/__pycache__/methodkerosene.cpython-311.pyc b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/kerosene/__pycache__/methodkerosene.cpython-311.pyc
deleted file mode 100644
index 803a0b986a463019e0f072d5c755c66b9725e9b8..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 2179
zcmZ3^%ge>Uz`)?Kq9{#<oq^#ohy%k+P{wBo1_p-d3@Hpz3@MB$OgW5Ej48}53{gxe
zOu-DAELAqX`6;D2sR{)}`DK|YnR)37$%#41r8$WunfZANX{C9|AVx7%J~c%lsZyaN
zBUPcaIJHRcCCC!LWL6Lb#mo#03?Tfu4`MH43R4R69Hv^<8kPl6C8$&i%Q8j=hSiKP
zQAP%wDp`qEiD@QlFoPyrVhRfbgMUG4QDO<$r}@Pt3aP~<nYj?(=BAcp<fkYkCMV|?
zfrFwXUm+w^!6~&UCo@kWEx$-1JGCgkI5jU-w;;bfwJ0@3Au+QkxhOHMM30M0K|w(w
zBqOsJ9%u>$sYPk|MY+Y`0L#Z|EsA}hutnGjbrD{x!4@ay=cQ$)mx4T&pI5907K?UF
zNm0nnFG^L&%mcXt;>nEEqEtOSy;!i4kc?D?{L+$w(h`M~OmIvm7F8;!!@L;}k&6e(
zsVgMs=anR8=0Utulv-SxQ&Oyup9c0_GFnh3=A|fP7Aq8&6qP2Il!8MF7OG&2OY*_m
z((-e1^2<SSQJkESnwx3`mIQ?)HYX_9Dpac%Bo-y+rk11@#T%+yDU>DVl&0#yb%AtZ
z!$`V}V7h7{QDy};5bS-0g2a-H;`qe8l=!^F+|*(#1s6o1Kz$E(Yh`gsYA!^z0?4PX
zIjOm+c_kr5sj0<aw;&r@lwS%;ZQww}Wg=9K0@y7e&tVz^ii7yX<oMKz<c!3;^i+sZ
zut)(p3!xe8C`7UX2U4*@T2X#3Ji#i!%uz_o%t^&?G}yM>{FHb|!XneMTu9jhF$0=7
zG3?99PfyRxOV{(sPft%RQYb3TE6L1Fg(f{K1&}bvclk+KsmUdvawi3x6_XPSN=l1B
zGCBF_3c0Dp#fj;u#R{2u;DiOS8RD&?)RNMoJV*><OI8riW#;FB(mql&!;&~S+)zqI
zd?f+c&X;lw3=A(d7#J8dnQm#NWEQ0+m&C(MfOt@D0j0CN(!`wjl+@zP^t||j{LH+P
zTN0Uh*i~0q>5>hqOr!ns6`*BFW^Mr_wWg*hRHl|FXedD>U?HPdP^qM;7ptJ4pvicP
zwV)_7uSApW7C&0nxWxlavfyNWO8}f+kW%L@ey|841>NF9jo4cvFbknE4K}Elje&sy
zl7WA1(GM+7Eh^S8$w*Dh$uF<U&r8*J$xki?<+Ngb1A}<y{FGGvpwxo=;>?o#qRiA{
z{US$baqI#PQ~lJ6M38U6;T?}C==F<>lJ!eUlTyK19aQ}2r{)%97G)+U=IEow5|Xa?
zlG6Aja8;lWbGkl8(B0yP2*tyc6bUdeFmNz1Fcc>+FfcSQd{ATXX7pveVPW-wnNh~(
z0|TRs%>@>T4;&1v!q-_OF0n{lkPN-Z5_W|p>;g;J4HhAoV8BI|z$+|)7gz$31Q9A9
zaLZp{k^c;;MKzgkvB$@!<R{0+-(oJVECxGaB}0)Q0|P@5KLZ29FAf_>{;(?&Wnf?c
nRlUW!3=9k(m>C%vZ!kDrU~qcCz|{bTAGo9$6+SRv5@6#1(b2dy
diff --git "a/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/liquid_hydrogen/Icon\r" "b/docs/get-involved/modularization/python-template/AircraftDesign/cost_estimation/src/tube_and_wing/empirical/operating_cost_estimation_tu_berlin/liquid_hydrogen/Icon\r"
deleted file mode 100644
index e69de29..0000000
--
GitLab