diff --git a/docs/assets/UNICADOinstaller.exe b/docs/assets/UNICADOinstaller.exe
new file mode 100644
index 0000000000000000000000000000000000000000..2b36afcd74a21ebcd32cebb321cb4d512c87616b
Binary files /dev/null and b/docs/assets/UNICADOinstaller.exe differ
diff --git a/docs/documentation/analysis/ecological_assessment/basic-concepts.md b/docs/documentation/analysis/ecological_assessment/basic-concepts.md
index 7113399de6e7380e50db90c3edf052835f9d99e8..6993cbae19f3ee8e0564c97d66c96e7370b36483 100644
--- a/docs/documentation/analysis/ecological_assessment/basic-concepts.md
+++ b/docs/documentation/analysis/ecological_assessment/basic-concepts.md
@@ -649,7 +649,7 @@ Other inputs are mission related. The design mission taxi time is needed and rea
├── taxi_time_destination
```
-And last but not least, the emissions provided by the submodule [mission_emissions](mission_emissions) will be read from *ecological_assessment_results.xml*:
+And last but not least, the emissions provided by the submodule [mission_emissions](#mission-emissions) will be read from *ecological_assessment_results.xml*:
```
mission_emissions/
diff --git a/docs/documentation/analysis/ecological_assessment/usage.md b/docs/documentation/analysis/ecological_assessment/usage.md
index 483c52b44db8491b07bdf1774fcb4e1fed7161de..605b4c4823975b4fca41e1f831b66aaff6825c15 100644
--- a/docs/documentation/analysis/ecological_assessment/usage.md
+++ b/docs/documentation/analysis/ecological_assessment/usage.md
@@ -2,7 +2,7 @@
You have carefully read the [basic-concepts](basic-concepts.md) and feel ready to assess your first aircraft? Great! :fire: This guide will show you step by step the basic usage of the _ecological\_assessment_ tool.
## Prerequisites
-1. It is assumed that you have the `UNICADO Package` installed, including the executables and UNICADO libraries. If you are a developer, you need to build the tool first (see [build instructions on the UNICADO website](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/developer/build/cpp/)).
+1. It is assumed that you have the `UNICADO Package` installed, including the executables and UNICADO libraries. If you are a developer, you need to build the tool first (see [build instructions on the UNICADO website](../../../get-involved/build-instructions/build/cpp.md)).
2. Fill out the configuration file `ecological_assessment_conf.xml`. Check and change if needed at least following settings:
- change in `control_settings`:
```
@@ -33,7 +33,7 @@ You have carefully read the [basic-concepts](basic-concepts.md) and feel ready t
└── method/
```
- all other parameters can be left at default values
-3. You need to provide all necessary input data. What is necessary depends on the chosen methods (or executed submodule). In general, you need a (shortened) project environment as described in [Seperate Tool Execution](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/tutorials/seperate-tool-execution/). The aircraft exchange file need to located at the path you defined in the configuration file. Here is an example with a CSMR-2020 in the projects directory:
+3. You need to provide all necessary input data. What is necessary depends on the chosen methods (or executed submodule). In general, you need a (shortened) project environment as described in [Seperate Tool Execution](https://unicado.pages.rwth-aachen.de/unicado.gitlab.io/tutorials/seperate-tool-execution/). The aircraft exchange file need to located at the path you defined in the configuration file. Here is an example with an aircraft exchange file in the projects directory:
```
@@ -42,9 +42,9 @@ You have carefully read the [basic-concepts](basic-concepts.md) and feel ready t
│ ├── ecological_assessment.exe
│ └── ecological_assessment_conf.xml
├── projects/
- │ └── CSMR/
- │ └──CSMR-2020
- │ └── CSMR-2020.xml
+ │ └── aircraft-type/
+ │ └──aircraft-name
+ │ └── aircraft-name.xml
├── databases/
│ └── engine/
└── libs/
diff --git a/docs/documentation/analysis/index.md b/docs/documentation/analysis/index.md
index d58b339cdc2a66fda264398330629692fd33e661..ac2d5943c8a220c23ab8ec019eaf056687a7bd49 100644
--- a/docs/documentation/analysis/index.md
+++ b/docs/documentation/analysis/index.md
@@ -26,32 +26,6 @@ lift mach numbers.
---
-## Mission analysis
-{.overview-img align=left}
-The module `mission_analysis` is the key module of the aircraft performance analysis.
-Its purpose is to calculate the flight trajectory, based on the inputs of the preliminary aircraft design cycle, by solving the aircraft equations of motion being simplified as a point mass model.
-Depending on the method, the fuel consumption is calculated either:
-
-- in segments by using the Breguet range formula, or
-- in a full-mission time-history simulation (the flight mission is divided into increments. For each increment the movement equations are solved, followed by the thrust requirements and fuel consumption)
-
-|Module Version|Language|License|Documentation|
-|:---:|:---:|:---:|---|
-|0.5.0|:simple-cplusplus: |GPLv3|[Link](mission_analysis/index.md)|
-
----
-
-## Weight and balance analysis
-{.overview-img align=left}
-The `weight_and_balance_analysis` module calculates sub-masses and total masses of the aircraft including center of gravities.
-{.overview-item}
-
-|Module Version|Language|License|Documentation|
-|:---:|:---:|:---:|---|
-|0.5.0|:simple-python: |GPLv3|[Link](weight_and_balance_analysis/index.md)|
-
----
-
## Constraint analysis
{.overview-img align=left}
The `constraint_analysis` module updates the performance criteria wing loading and thrust-to-weight-ratio based on the calculated aircraft data.
@@ -62,17 +36,6 @@ The `constraint_analysis` module updates the performance criteria wing loading a
|0.5.0|:simple-cplusplus: |GPLv3|[Link](constraint_analysis/index.md)|
----
-
-## Performance assessment
-{.overview-img align=left}
-The module `calculatePerformance` is used to evaluate the mission performance of the design.
-{.overview-item}
-
-|Module Version|Language|License|Documentation|
-|:---:|:---:|:---:|---|
-|0.5.0|:simple-cplusplus:| GPLv3 |[Link](performance_assessment/index.md)|
-
---
## Cost estimation
@@ -101,4 +64,42 @@ Its purpose is to calculate the emissions and energy demand within the aircraft'
|:---:|:---:|:---:|---|
|0.5.0|:simple-cplusplus: |GPLv3|[Link](ecological_assessment/index.md)|
----
\ No newline at end of file
+---
+
+## Mission analysis
+{.overview-img align=left}
+The module `mission_analysis` is the key module of the aircraft performance analysis.
+Its purpose is to calculate the flight trajectory, based on the inputs of the preliminary aircraft design cycle, by solving the aircraft equations of motion being simplified as a point mass model.
+Depending on the method, the fuel consumption is calculated either:
+
+- in segments by using the Breguet range formula, or
+- in a full-mission time-history simulation (the flight mission is divided into increments. For each increment the movement equations are solved, followed by the thrust requirements and fuel consumption)
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|0.5.0|:simple-cplusplus: |GPLv3|[Link](mission_analysis/index.md)|
+
+---
+
+## Performance assessment
+{.overview-img align=left}
+The module `calculatePerformance` is used to evaluate the mission performance of the design.
+{.overview-item}
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|0.5.0|:simple-cplusplus:| GPLv3 |[Link](performance_assessment/index.md)|
+
+---
+
+## Weight and balance analysis
+{.overview-img align=left}
+The `weight_and_balance_analysis` module calculates sub-masses and total masses of the aircraft including center of gravities.
+{.overview-item}
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|0.5.0|:simple-python: |GPLv3|[Link](weight_and_balance_analysis/index.md)|
+
+---
+
diff --git a/docs/documentation/analysis/performance_assessment/ceiling_performance.md b/docs/documentation/analysis/performance_assessment/ceiling_performance.md
index b947e4a0893287c0fc138f3b4c718447ee9a827d..0fe15692f4a094c1d8c38994d92019da76301e39 100644
--- a/docs/documentation/analysis/performance_assessment/ceiling_performance.md
+++ b/docs/documentation/analysis/performance_assessment/ceiling_performance.md
@@ -1,4 +1,4 @@
-# Software architecture
+# Ceiling Performance
This site is currently under development. :construction:
<!--
diff --git a/docs/documentation/analysis/performance_assessment/flight_envelope.md b/docs/documentation/analysis/performance_assessment/flight_envelope.md
index b947e4a0893287c0fc138f3b4c718447ee9a827d..47828d3f07aa337531e96c373fdb3c32b5f8f65f 100644
--- a/docs/documentation/analysis/performance_assessment/flight_envelope.md
+++ b/docs/documentation/analysis/performance_assessment/flight_envelope.md
@@ -1,4 +1,4 @@
-# Software architecture
+# Flight Envelope
This site is currently under development. :construction:
<!--
diff --git a/docs/documentation/analysis/performance_assessment/landing_performance.md b/docs/documentation/analysis/performance_assessment/landing_performance.md
index b947e4a0893287c0fc138f3b4c718447ee9a827d..ea255ad8c7314fad2e8bd68269b48e27fb2ba697 100644
--- a/docs/documentation/analysis/performance_assessment/landing_performance.md
+++ b/docs/documentation/analysis/performance_assessment/landing_performance.md
@@ -1,4 +1,4 @@
-# Software architecture
+# Landing Performance
This site is currently under development. :construction:
<!--
diff --git a/docs/documentation/analysis/performance_assessment/takeoff_performance.md b/docs/documentation/analysis/performance_assessment/takeoff_performance.md
index b947e4a0893287c0fc138f3b4c718447ee9a827d..f53ec3686ce55c8a92ea5b989a46b805147bcc44 100644
--- a/docs/documentation/analysis/performance_assessment/takeoff_performance.md
+++ b/docs/documentation/analysis/performance_assessment/takeoff_performance.md
@@ -1,4 +1,4 @@
-# Software architecture
+# Takeoff Performance
This site is currently under development. :construction:
<!--
diff --git a/docs/documentation/analysis/weight_and_balance_analysis/index.md b/docs/documentation/analysis/weight_and_balance_analysis/index.md
index 064927a834c6a5ad964da7280805a3857bdeaed9..9337091206b7bf4a23c95e8f5c036f1897c886df 100644
--- a/docs/documentation/analysis/weight_and_balance_analysis/index.md
+++ b/docs/documentation/analysis/weight_and_balance_analysis/index.md
@@ -4,7 +4,7 @@ The aircraft’s mass plays a crucial role in determining the flight performance
In UNICADO, the _weight\_and\_balance_analysis_ tool is used to compute the aircraft's masses, determine the CG positions, calculate mass moments of inertia, and generate the loading diagram. The terms "mass" and "weight" are often used interchangeably in aircraft design, though they are scientifically distinct. In this context, both terms are used to refer to the aircraft's mass.
## A User's Guide to Weight & Balance Analysis
-This user documentation will guide you through all necessary steps to understand the tool as well as the necessary inputs and configurations to calculate the aircraft masses, CG positions, aircraft's moments of inertia and determine the loading diagramm with the most forward and most aft CG positions.
+This user documentation will guide you through all necessary steps to understand the tool as well as the necessary inputs and configurations to calculate the aircraft masses, CG positions, aircraft's moments of inertia and determine the loading diagramm with the most forward and most aft CG positions.
The following pages will guide you through the theory behind and the process of computing and analysing the weight and balance within UNICADO:
@@ -21,8 +21,8 @@ If you are familiar with these concepts and want to contribute - head over to th
The following pages will help you understand the code structure:
- [Developer Guide](../../../get-involved/developer-installation.md)
-- [Build Instructions](../../../get-involved/build/general.md)
-- [How to Python in UNICADO](../../../get-involved/style/python-modularization.md)
+- [Build Instructions](../../../get-involved/build-instructions/build/python.md)
+- [How to Python in UNICADO](../../../get-involved/modularization/python-modularization.md)
- [Weight & Balance Analysis Tool Structure](usage.md)
We appreciate it!
diff --git a/docs/documentation/analysis/weight_and_balance_analysis/usage.md b/docs/documentation/analysis/weight_and_balance_analysis/usage.md
index abd686b1d5546795226ffd33f9108eef843809da..6c568a70d17f33d79df95e35d402a8d2ca597623 100644
--- a/docs/documentation/analysis/weight_and_balance_analysis/usage.md
+++ b/docs/documentation/analysis/weight_and_balance_analysis/usage.md
@@ -123,7 +123,7 @@ In this part of the configXML we can select the calculation methods and aircraft
- the loading sequence is first refueling (ref), then boarding the passengers, after that adding the cargo and finally defueling (def).
## Tool Execution {#tool}
-Once the desired methods are selected and the requirements are in place, the tool can run. In order to start the w&b analysis tool, we can execute it directly from the console if all paths are set (see [How to run a tool](howToRunATool.md)) or run the _main.py_ inside the tool folder.
+Once the desired methods are selected and the requirements are in place, the tool can run. In order to start the w&b analysis tool, we can execute it directly from the console if all paths are set (see [How to run a tool](../../../tutorials/seperate-tool-execution.md)) or run the _main.py_ inside the tool folder.
Following will happen:
diff --git a/docs/documentation/sizing/create_mission_xml/getting_started.md b/docs/documentation/sizing/create_mission_xml/getting_started.md
index 51efce0f3b022a6bb6f7cec0f51c5ac8a5722d48..09a1284039baa0b073626a7021837aae57100dd1 100644
--- a/docs/documentation/sizing/create_mission_xml/getting_started.md
+++ b/docs/documentation/sizing/create_mission_xml/getting_started.md
@@ -277,7 +277,7 @@ Like we have already discussed, the output of **create_mission_xml** is the miss
Bleed air and power offtakes are not displayed here, but every step will include these, too. Offtakes are written and explained by [Systems Design](../systems_design/index.md).
-While the most parameters like `range` and `alternate_distance` are copied directly from [Aircraft Exchange File](#acxml) and [Configuration File](#config_file), the `payload` is derived from the given number of passengers, their luggage and the mass per passenger. Each step (`departure_step`, `cruise_step` or `approach_step`) contains the nodes `configuration`, `mode`, `derate` and `rating`. The `configuration` node will tell [Mission Analysis](../../analysis/mission_analysis/index.md) which polar (generated by [Aerodynamic Assessment](../../sizing/aerodynamic_analysis/index.md)) shall be used. `derate` and `rating` characterize the engine operations and `mode` specifies what shall happen during the segment between two steps (more infos about `modes`, [click here](../../analysis/mission_analysis/mission_steps.md/#step_modes)). Furthermore, `cruise_steps` always include `flight_management_system` and `auto_select_optimum_flight_level` nodes.
+While the most parameters like `range` and `alternate_distance` are copied directly from [Aircraft Exchange File](#acxml) and [Configuration File](#config_file), the `payload` is derived from the given number of passengers, their luggage and the mass per passenger. Each step (`departure_step`, `cruise_step` or `approach_step`) contains the nodes `configuration`, `mode`, `derate` and `rating`. The `configuration` node will tell [Mission Analysis](../../analysis/mission_analysis/index.md) which polar (generated by [Aerodynamic Assessment](../../analysis/aerodynamic_analysis/index.md)) shall be used. `derate` and `rating` characterize the engine operations and `mode` specifies what shall happen during the segment between two steps (more infos about `modes`, [click here](../../analysis/mission_analysis/mission_steps.md/#step_modes)). Furthermore, `cruise_steps` always include `flight_management_system` and `auto_select_optimum_flight_level` nodes.
Other entries within these steps can differ depending on which `mode` is used. What input nodes are needed can be found in the descriptions of `departure`, `cruise` and `approach`. As a rule of thumb, the following input nodes can usually be expected:
diff --git a/docs/documentation/sizing/empennage_design/index.md b/docs/documentation/sizing/empennage_design/index.md
index 9b6b859d88693153513bcb2855a158b50ae084e2..67240c12dbf83c6db62c1ce332b428f609c9c188 100644
--- a/docs/documentation/sizing/empennage_design/index.md
+++ b/docs/documentation/sizing/empennage_design/index.md
@@ -29,9 +29,9 @@ The _empennage\_design_ tool will help you design various empennages for classic
The following pages will guide you through the process of generating your first empennage within UNICADO:
-[:octicons-arrow-right-16: Basic Concepts](basic-concepts.md)
-[:octicons-arrow-right-16: Getting Started](getting-started.md)
-[:octicons-arrow-right-16: Design Methods](design-methods.md)
+[:octicons-arrow-right-16: Basic Concepts](basic-concepts.md)
+[:octicons-arrow-right-16: Getting Started](getting-started.md)
+[:octicons-arrow-right-16: Design Methods](design-methods.md)
[:octicons-arrow-right-16: Design your first empennage](run-your-first-empennage-design.md)
So let's get started!
@@ -43,9 +43,9 @@ If you are familiar with these concepts and want to contribute - head over to th
The following pages will help you understand the code structure:
-[:octicons-arrow-right-16: Prerequisites](prerequisites.md)
-[:octicons-arrow-right-16: Build the code](../../../get-involved/build-instructions/build/python.md)
-[:octicons-arrow-right-16: Empennage module structure](empennage-module-structure.md)
+[:octicons-arrow-right-16: Prerequisites](prerequisites.md)
+[:octicons-arrow-right-16: Build the code](../../../get-involved/build-instructions/build/cpp.md)
+[:octicons-arrow-right-16: Empennage module structure](module-structure.md)
[:octicons-arrow-right-16: Method template](method-template.md)
We appreciate it!
diff --git a/docs/documentation/sizing/empennage_design/method-template.md b/docs/documentation/sizing/empennage_design/method-template.md
new file mode 100644
index 0000000000000000000000000000000000000000..dc713ebd182509859e8cc6033c3917c93768438e
--- /dev/null
+++ b/docs/documentation/sizing/empennage_design/method-template.md
@@ -0,0 +1 @@
+> :construction: This site is currently under construction.
\ No newline at end of file
diff --git a/docs/documentation/sizing/empennage_design/module-structure.md b/docs/documentation/sizing/empennage_design/module-structure.md
new file mode 100644
index 0000000000000000000000000000000000000000..dc713ebd182509859e8cc6033c3917c93768438e
--- /dev/null
+++ b/docs/documentation/sizing/empennage_design/module-structure.md
@@ -0,0 +1 @@
+> :construction: This site is currently under construction.
\ No newline at end of file
diff --git a/docs/documentation/sizing/empennage_design/prerequisites.md b/docs/documentation/sizing/empennage_design/prerequisites.md
new file mode 100644
index 0000000000000000000000000000000000000000..dc713ebd182509859e8cc6033c3917c93768438e
--- /dev/null
+++ b/docs/documentation/sizing/empennage_design/prerequisites.md
@@ -0,0 +1 @@
+> :construction: This site is currently under construction.
\ No newline at end of file
diff --git a/docs/documentation/sizing/index.md b/docs/documentation/sizing/index.md
index 7f183f55852fd0c45d05c8c1b43dfd7c6da710e0..1b24fab2263a9cc4e428fb4e63b88717dd3eaa18 100644
--- a/docs/documentation/sizing/index.md
+++ b/docs/documentation/sizing/index.md
@@ -14,19 +14,6 @@ The following sizing tools are available:
---
-## Initial sizing
-{.overview-img align=left}
-The module **initial_sizing** is used to determine a design chart regarding Top Level Aircraft Requirements and Certification Specification Requirements.
-The wing-loading ($\frac{W}{S}$) and thrust to weight ratio ($\frac{T}{W}$) can be derived as the design point for further modules from the Design Chart.
-Furthermore an initial estimation of the takeoff mass is done.
-{.overview-item}
-
-|Module Version|Language|License|Documentation|
-|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link](initial_sizing/index.md)|
-
----
-
## Create mission XML
{.overview-img align=left}
The **create_mission_XML** is the third module of the UNICADO tool chain.
@@ -36,53 +23,54 @@ For the user, possible changes in the module run configuration can be made in th
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link](create_mission_xml/index.md)|
+|0.5.0|:simple-cplusplus: |GPLv3|[Link](create_mission_xml/index.md)|
---
-## Fuselage design
-{.overview-img align=left}
-The **fuselage_design** module calculates characteristic parameters and generates the passenger cabin and fuselage layout for the entire aircraft project.
+## Empennage design
+{.overview-img align=left}
+The **empennage_design** module calculates characteristic parameter of the empennage of the aircraft.
+It takes takes the controllability as wells as the static margin of the aircraft into account and sizes the empennage accordingly.
{.overview-item}
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link](fuselage_design/index.md)|
+|0.5.0|:simple-cplusplus: |GPLv3|[Link](empennage_design/index.md)|
---
-## Wing design
-{.overview-img align=left}
-The **wing_design** module calculates characteristic parameter of the aircraft main wing.
+## Fuselage design
+{.overview-img align=left}
+The **fuselage_design** module calculates characteristic parameters and generates the passenger cabin and fuselage layout for the entire aircraft project.
{.overview-item}
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link](wing_design/index.md)|
+|0.5.0|:simple-cplusplus: |GPLv3|[Link](fuselage_design/index.md)|
---
-## Empennage design
-{.overview-img align=left}
-The **empennage_design** module calculates characteristic parameter of the empennage of the aircraft.
-It takes takes the controllability as wells as the static margin of the aircraft into account and sizes the empennage accordingly.
+## Initial sizing
+{.overview-img align=left}
+The module **initial_sizing** is used to determine a design chart regarding Top Level Aircraft Requirements and Certification Specification Requirements.
+The wing-loading ($\frac{W}{S}$) and thrust to weight ratio ($\frac{T}{W}$) can be derived as the design point for further modules from the Design Chart.
+Furthermore an initial estimation of the takeoff mass is done.
{.overview-item}
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link](empennage_design/index.md)|
+|0.5.0|:simple-cplusplus: |GPLv3|[Link](initial_sizing/index.md)|
---
-## Tank design
-{.overview-img align=left}
-The **tank_design** module performs calculations regarding the tank. For kerosene tanks, the maximum fuel capacity of the aircraft is determined by using its geometry. Liquid hydrogen tanks will be sized according to the required amount of fuel.
+## Landing gear design
+{.overview-img align=left}
+The **landing_gear_design** module calculates characteristic parameters for the landing gear of entire aircraft project.
{.overview-item}
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-python: |GPLv3|[Link](tank_design/index.md)|
-
+|0.5.0|:simple-cplusplus: |GPLv3|[Link](landing_gear_design/index.md)|
---
@@ -99,29 +87,41 @@ Also the mass properties are analyzed.
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|3.0.0|:simple-cplusplus: |GPLv3|[Link](propulsion_design/index.md)|
+|0.5.0|:simple-cplusplus: |GPLv3|[Link](propulsion_design/index.md)|
---
-## Landing gear design
-{.overview-img align=left}
-The **landing_gear_design** module calculates characteristic parameters for the landing gear of entire aircraft project.
+## Systems design
+{.overview-img align=left}
+The **systems_design** is part of the tool chain in the UNICADO aircraft design environment.
+It dimensions ATA chapter systems in terms of mass and energy requirement divided by hydraulic- electric- and bleed air energy requirement.
{.overview-item}
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link](landing_gear_design/index.md)|
+|0.5.0|:simple-cplusplus: |GPLv3|[Link](systems_design/index.md)|
---
-## Systems design
-{.overview-img align=left}
-The **systems_design** is part of the tool chain in the UNICADO aircraft design environment.
-It dimensions ATA chapter systems in terms of mass and energy requirement divided by hydraulic- electric- and bleed air energy requirement.
+## Tank design
+{.overview-img align=left}
+The **tank_design** module performs calculations regarding the tank. For kerosene tanks, the maximum fuel capacity of the aircraft is determined by using its geometry. Liquid hydrogen tanks will be sized according to the required amount of fuel.
+{.overview-item}
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|0.5.0|:simple-python: |GPLv3|[Link](tank_design/index.md)|
+
+---
+
+## Wing design
+{.overview-img align=left}
+The **wing_design** module calculates characteristic parameter of the aircraft main wing.
{.overview-item}
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link](systems_design/index.md)|
+|0.5.0|:simple-cplusplus: |GPLv3|[Link](wing_design/index.md)|
---
+
diff --git a/docs/documentation/sizing/wing_design/index.md b/docs/documentation/sizing/wing_design/index.md
index d94fe37a6ace719f8dad6ea3b63d6c48997ebe1e..d60a3ecd22277dc877d1484930eb6f33e26730e9 100644
--- a/docs/documentation/sizing/wing_design/index.md
+++ b/docs/documentation/sizing/wing_design/index.md
@@ -23,7 +23,7 @@ Here is a quick overview of what the tool is currently capable of including a pr
| blended-wing-body | ... | ... | under development :construction: |
## A User's Guide to Wing Design
-The _wing\_design_ tool will help you design various wings for classical configurations to blended wing body confiugartions (in the future). This user documentation will guide you through all necessary steps to understand the tool as well as the necessary inputs and configurations to create a new wing from scratch.
+The _wing\_design_ tool will help you design various wings for classical configurations to blended wing body configurations (in the future). This user documentation will guide you through all necessary steps to understand the tool as well as the necessary inputs and configurations to create a new wing from scratch.
The following pages will guide you through the process of generating your first wing within UNICADO:
@@ -42,8 +42,8 @@ If you are familiar with these concepts and want to contribute - head over to th
The following pages will help you understand the build process code structure:
[:octicons-arrow-right-16: Prerequisites](prerequisites.md)
-[:octicons-arrow-right-16: Build the code](build-the-code.md)
-[:octicons-arrow-right-16: Wing module structure](wing-module-structure.md)
+[:octicons-arrow-right-16: Build the code](../../../get-involved/build-instructions/build/python.md)
+[:octicons-arrow-right-16: Wing module structure](module-structure.md)
[:octicons-arrow-right-16: Method template](method-template.md)
We appreciate it!
diff --git a/docs/documentation/sizing/wing_design/method-template.md b/docs/documentation/sizing/wing_design/method-template.md
new file mode 100644
index 0000000000000000000000000000000000000000..dc713ebd182509859e8cc6033c3917c93768438e
--- /dev/null
+++ b/docs/documentation/sizing/wing_design/method-template.md
@@ -0,0 +1 @@
+> :construction: This site is currently under construction.
\ No newline at end of file
diff --git a/docs/documentation/sizing/wing_design/module-structure.md b/docs/documentation/sizing/wing_design/module-structure.md
new file mode 100644
index 0000000000000000000000000000000000000000..dc713ebd182509859e8cc6033c3917c93768438e
--- /dev/null
+++ b/docs/documentation/sizing/wing_design/module-structure.md
@@ -0,0 +1 @@
+> :construction: This site is currently under construction.
\ No newline at end of file
diff --git a/docs/documentation/sizing/wing_design/prerequisites.md b/docs/documentation/sizing/wing_design/prerequisites.md
new file mode 100644
index 0000000000000000000000000000000000000000..dc713ebd182509859e8cc6033c3917c93768438e
--- /dev/null
+++ b/docs/documentation/sizing/wing_design/prerequisites.md
@@ -0,0 +1 @@
+> :construction: This site is currently under construction.
\ No newline at end of file
diff --git a/docs/download/takeoff.md b/docs/download/takeoff.md
index d192bd6757adfe2aab2e67261a3317c452a4d065..11e3fb9bf8d99a1a611159f09b0e97ec61add42b 100644
--- a/docs/download/takeoff.md
+++ b/docs/download/takeoff.md
@@ -9,7 +9,7 @@ authors:
date: 2024-11-05
---
## Installer
-When you fullfil all the [requirements](requirements.md), you can download and install the workflow with the current [:material-download: UNICADO installer](). This [standalone workflow tutorial](../tutorials/standalone.md) will show you in a video how this will look like.
+When you fullfil all the [requirements](requirements.md), you can download and install the workflow with the current [:material-download: UNICADO installer](../assets/UNICADOinstaller.exe). This [standalone workflow tutorial](../tutorials/standalone.mp4) will show you in a video how this will look like.
## Troubleshooting
Your installation aborts and the window closes suddenly:
diff --git a/docs/get-involved/build-instructions/build/general.md b/docs/get-involved/build-instructions/build/general.md
index bf06ac7075c8a37681d534f0f84277a44d979dcf..89fa92176ebb762a6204585a04ed0f9525886fdd 100644
--- a/docs/get-involved/build-instructions/build/general.md
+++ b/docs/get-involved/build-instructions/build/general.md
@@ -8,7 +8,7 @@ To understand **UNICADO's code base**, there are some things you need to know:
1. The code is in both :simple-cplusplus: C++ and :simple-python: Python. This makes the software especially exciting for development :fire:.
-2. We work a lot with executables in order to integrate them into the workflow (you might have seen this the [standalone download](../../../download/takeoff.md)).
+2. We work a lot with executables in order to integrate them into the workflow.
3. For generating the build files, **UNICADO** uses [CMake :octicons-link-external-16:](https://cmake.org/){:target="_blank"}.
CMake is a build system generator, which allows for cross-platform compilation.
diff --git a/docs/get-involved/build-instructions/build/python.md b/docs/get-involved/build-instructions/build/python.md
index 6bacd1a18788f25117a12927203c2165672d12b2..1673c80158e4fcb95ffa9673994fa8ebfcc11450 100644
--- a/docs/get-involved/build-instructions/build/python.md
+++ b/docs/get-involved/build-instructions/build/python.md
@@ -6,8 +6,6 @@ authors:
- Kristina Mazur
date: 2024-11-05
---
-> :construction: tbd
-
Some modules are written in Python. Although, the tools can run without Cmake, the recommended way is to still use it to create the virtual environment (at least for configuration!). However, if you are an expert, feel free to do it by yourself :material-arm-flex: !
In the following, it is explained how to [configure](#configure) and [build](#build) with CMake. It is pretty straight-forward as it is the same procedure as for C++ - just with one slight addition!
diff --git a/docs/imprint.md b/docs/imprint.md
index 60c44baef641f3c7c858d7f58e41f747bbeb2033..e80413a849b004b12a8246c486e38865fc983a84 100644
--- a/docs/imprint.md
+++ b/docs/imprint.md
@@ -52,4 +52,4 @@ Email Web Editorial Office: :email: [zentralredaktion@zhv.rwth-aachen.de](mailto
The above information also applies to our social media channels: Facebook, Youtube, Instagram, X, LinkedIn, Pinterest, TikTok and Threads.
-The web content of the Central University Administration, central administration facilities, group representatives, institutes, chairs, and research areas are coordinated independently under the direction of apppointed web coordinators and webmasters. Information for questions on liability can be found in the [Privacy Policy](../private-policy).
\ No newline at end of file
+The web content of the Central University Administration, central administration facilities, group representatives, institutes, chairs, and research areas are coordinated independently under the direction of apppointed web coordinators and webmasters. Information for questions on liability can be found in the [Privacy Policy](private-policy.md).
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index f527d9ba4839cefbf295454cc7a37bf3fd0ca349..dec7d0553ae1067772859b74b2f5c311af347d5d 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -41,7 +41,7 @@ Learn how to set it up & install the prerequisites.
Design your first aircraft.
-[:octicons-arrow-right-24: Tutorials](tutorials/standalone.md)
+[:octicons-arrow-right-24: Tutorials](tutorials/standalone.mp4)
</div>
<div class="grid-item card" markdown="1">
diff --git a/docs/private-policy.md b/docs/private-policy.md
index 0169c8baf31ab97bf525913f7c87c657bc0c74b4..6ce5f0b4a969e5642aff06b67b2d9d73ae5b8a1b 100644
--- a/docs/private-policy.md
+++ b/docs/private-policy.md
@@ -176,7 +176,7 @@ The data will be deleted as soon as it is no longer needed to achieve the purpos
At any time the user has the opportunity to revoke their consent to the processing of their personal data. When the user contacts RWTH Aachen University by email, they can object to the storage of their personal data at any time. In this case, however, the conversation cannot be continued.
-To revoke your consent to the data being processed and/or to object against data storage, please use the following email address: [impressum@rwth-aachen.de](impressum@rwth-aachen.de)
+To revoke your consent to the data being processed and/or to object against data storage, please use the following email address: [impressum@rwth-aachen.de](mailto:impressum@rwth-aachen.de)
In this case, all personal data stored in the context of the user's contacting RWTH Aachen University will be deleted.
diff --git a/docs/tutorials/seperate-tool-execution.md b/docs/tutorials/seperate-tool-execution.md
index c4ebcdf4f5bf7d9cbef9f7dc3da69db8e5610aa2..0be7c4dc54ddfd6d4592598cd1ef8994bd5ef805 100644
--- a/docs/tutorials/seperate-tool-execution.md
+++ b/docs/tutorials/seperate-tool-execution.md
@@ -19,7 +19,7 @@ For testing purposes you most probably will choose the CSMR-2020 aircraft refere
## Project Environment
-For creating a **project environment** you have several options 🍟. Here we'll present the two mostly used ones (excluding the UNICADOworkflow on RCE stated [here](standalone.md)):
+For creating a **project environment** you have several options 🍟. Here we'll present the two mostly used ones (excluding the UNICADOworkflow on RCE stated [here](standalone.mp4)):
- Create a new folder for your project environment **or** use the folder where you have cloned the **Aircraft Design** repo. Both will be calles **project environment** in the following.
diff --git a/docs/tutorials/standalone.md b/docs/tutorials/standalone.md
deleted file mode 100644
index 916fbe650063935d31ab9dbac7ad0ac12b81ac7e..0000000000000000000000000000000000000000
--- a/docs/tutorials/standalone.md
+++ /dev/null
@@ -1,2 +0,0 @@
-!!! tip "ToDo"
- here should be a video showing the standalone workflow
diff --git a/docs/tutorials/standalone.mp4 b/docs/tutorials/standalone.mp4
new file mode 100644
index 0000000000000000000000000000000000000000..087d0f50ee781112c30fba4e567f8589241cf138
Binary files /dev/null and b/docs/tutorials/standalone.mp4 differ
diff --git a/mkdocs.yml b/mkdocs.yml
index ccf4f51ab99ea06995e56ccd84a7dfb798901b51..5db6bc4e50024914c92403e04a0c76876d44be77 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -252,24 +252,14 @@ nav: # Customizes the main navigation struc
- Requirements: download/requirements.md # Link to the installation requirements page.
- Cleared for Take-Off: download/takeoff.md # Link to the takeoff/getting started page.
- Tutorials:
- - Standalone Workflow: tutorials/standalone.md # Link to the standalone tutorial page.
- - Separate Tool Execution: tutorials/seperate-tool-execution.md # Link to the separate tool execution tutorial page.
- Changing Design Specifications: tutorials/changing-design-specifications.md
+ - "Video: Standalone Workflow": tutorials/standalone.mp4 # Link to the standalone tutorial video.
+ - Separate Tool Execution: tutorials/seperate-tool-execution.md # Link to the separate tool execution tutorial page.
- Documentation: # Top-level item for documentation.
- Overview: documentation/overview.md # Overview of modules.
- Aircraft Design:
- Sizing:
- documentation/sizing/index.md # Link to aircraft sizing documentation.
- - Initial Sizing:
- - Introduction: documentation/sizing/initial_sizing/index.md
- - Getting Started: documentation/sizing/initial_sizing/getting-started.md
- - Methods: documentation/sizing/initial_sizing/initialSizing.md
- - Changelog: documentation/sizing/initial_sizing/changelog.md
- - API Reference:
- - initial_sizing/classes.md
- - initial_sizing/namespaces.md
- - initial_sizing/files.md
- - initial_sizing/functions.md
- Create Mission XML:
- Introduction: documentation/sizing/create_mission_xml/index.md
- Getting Started: documentation/sizing/create_mission_xml/getting_started.md
@@ -279,24 +269,6 @@ nav: # Customizes the main navigation struc
- create_mission_xml/namespaces.md
- create_mission_xml/files.md
- create_mission_xml/functions.md
- - Fuselage Design:
- - Introduction: documentation/sizing/fuselage_design/index.md
- - Getting Started: documentation/sizing/fuselage_design/getting_started.md
- - Design Method: documentation/sizing/fuselage_design/design_method.md
- - Run your First Design: documentation/sizing/fuselage_design/run_your_first_design.md
- - Software Architecture: documentation/sizing/fuselage_design/software_architecture.md
- # # - API Reference: # TODO define for Python
- - Wing Design:
- - Introduction: documentation/sizing/wing_design/index.md
- - Getting Started: documentation/sizing/wing_design/getting-started.md
- - Design Method: documentation/sizing/wing_design/design-methods.md
- - Basic Concepts: documentation/sizing/wing_design/basic-concepts.md
- - Run your First Design: documentation/sizing/wing_design/run-your-first-wing-design.md
- - API Reference:
- - wing_design/classes.md
- - wing_design/namespaces.md
- - wing_design/files.md
- - wing_design/functions.md
- Empennage Design:
- Introduction: documentation/sizing/empennage_design/index.md
- Getting Started: documentation/sizing/empennage_design/getting-started.md
@@ -308,12 +280,29 @@ nav: # Customizes the main navigation struc
- empennage_design/namespaces.md
- empennage_design/files.md
- empennage_design/functions.md
- - Tank Design:
- - Introduction: documentation/sizing/tank_design/index.md
- - Getting Started: documentation/sizing/tank_design/getting_started.md
- - Design Method: documentation/sizing/tank_design/tank_design_method.md
- - Run your First Design: documentation/sizing/tank_design/run_your_first_tank_design.md
- - Software Architecture: documentation/sizing/tank_design/software_architecture.md
+ - Fuselage Design:
+ - Introduction: documentation/sizing/fuselage_design/index.md
+ - Getting Started: documentation/sizing/fuselage_design/getting_started.md
+ - Design Method: documentation/sizing/fuselage_design/design_method.md
+ - Run your First Design: documentation/sizing/fuselage_design/run_your_first_design.md
+ - Software Architecture: documentation/sizing/fuselage_design/software_architecture.md
+ # - API Reference: # TODO define for Python
+ - Initial Sizing:
+ - Introduction: documentation/sizing/initial_sizing/index.md
+ - Getting Started: documentation/sizing/initial_sizing/getting-started.md
+ - Methods: documentation/sizing/initial_sizing/initialSizing.md
+ - Changelog: documentation/sizing/initial_sizing/changelog.md
+ - API Reference:
+ - initial_sizing/classes.md
+ - initial_sizing/namespaces.md
+ - initial_sizing/files.md
+ - initial_sizing/functions.md
+ - Landing Gear Design:
+ - Introduction: documentation/sizing/landing_gear_design/index.md
+ - Getting Started: documentation/sizing/landing_gear_design/getting_started.md
+ - Design Method: documentation/sizing/landing_gear_design/design_method.md
+ - Run your First Design: documentation/sizing/landing_gear_design/run_your_first_design.md
+ - Software Architecture: documentation/sizing/landing_gear_design/software_architecture.md
# - API Reference: # TODO define for Python
- Propulsion Design:
- Introduction: documentation/sizing/propulsion_design/index.md
@@ -327,13 +316,6 @@ nav: # Customizes the main navigation struc
- propulsion_design/namespaces.md
- propulsion_design/files.md
- propulsion_design/functions.md
- - Landing Gear Design:
- - Introduction: documentation/sizing/landing_gear_design/index.md
- - Getting Started: documentation/sizing/landing_gear_design/getting_started.md
- - Design Method: documentation/sizing/landing_gear_design/design_method.md
- - Run your First Design: documentation/sizing/landing_gear_design/run_your_first_design.md
- - Software Architecture: documentation/sizing/landing_gear_design/software_architecture.md
- # - API Reference: # TODO define for Python
- Systems Design:
- Introduction: documentation/sizing/systems_design/index.md
- Getting Started: documentation/sizing/systems_design/getting-started.md
@@ -344,30 +326,51 @@ nav: # Customizes the main navigation struc
- systems_design/namespaces.md
- systems_design/files.md
- systems_design/functions.md
- - Analysis:
- - Modules: documentation/analysis.md # Link to analysis module page.
- - Mission Analysis:
- - Introduction: documentation/analysis/mission_analysis/index.md
- - Getting Started: documentation/analysis/mission_analysis/getting_started.md
- - Mission Methods: documentation/analysis/mission_analysis/methods.md
- - Mission Steps: documentation/analysis/mission_analysis/mission_steps.md
+ - Tank Design:
+ - Introduction: documentation/sizing/tank_design/index.md
+ - Getting Started: documentation/sizing/tank_design/getting_started.md
+ - Design Method: documentation/sizing/tank_design/tank_design_method.md
+ - Run your First Design: documentation/sizing/tank_design/run_your_first_tank_design.md
+ - Software Architecture: documentation/sizing/tank_design/software_architecture.md
+ # - API Reference: # TODO define for Python
+ - Wing Design:
+ - Introduction: documentation/sizing/wing_design/index.md
+ - Getting Started: documentation/sizing/wing_design/getting-started.md
+ - Design Method: documentation/sizing/wing_design/design-methods.md
+ - Basic Concepts: documentation/sizing/wing_design/basic-concepts.md
+ - Run your First Design: documentation/sizing/wing_design/run-your-first-wing-design.md
- API Reference:
- - mission_analysis/classes.md
- - mission_analysis/namespaces.md
- - mission_analysis/files.md
- - mission_analysis/functions.md
- - Weight and Balance Analysis:
- - Introduction: documentation/analysis/weight_and_balance_analysis/index.md
- - Basic Concepts: documentation/analysis/weight_and_balance_analysis/basic-concepts.md
- - Usage: documentation/analysis/weight_and_balance_analysis/usage.md
- # # - API Reference: # TODO define for Python
+ - wing_design/classes.md
+ - wing_design/namespaces.md
+ - wing_design/files.md
+ - wing_design/functions.md
+ - Analysis:
+ - documentation/analysis/index.md # Link to analysis module page.
+ - Aerodynamic Analysis:
+ - Introduction: documentation/analysis/aerodynamic_analysis/index.md
+ - Getting Started: documentation/analysis/aerodynamic_analysis/getting_started.md
+ - Aerodynamic Principles: documentation/analysis/aerodynamic_analysis/aerodynamic_principles.md
+ - Software Architecture: documentation/analysis/aerodynamic_analysis/software_architecture.md
+ - API Reference:
+ - aerodynamic_analysis/classes.md
+ - aerodynamic_analysis/namespaces.md
+ - aerodynamic_analysis/files.md
+ - aerodynamic_analysis/functions.md
+ - Constraint Analysis:
+ - Introduction: documentation/analysis/constraint_analysis/index.md
+ - Principles: documentation/analysis/constraint_analysis/principles.md
+ - API Reference:
+ - constraint_analysis/classes.md
+ - constraint_analysis/namespaces.md
+ - constraint_analysis/files.md
+ - constraint_analysis/functions.md
- Cost Estimation:
- Introduction: documentation/analysis/cost_estimation/index.md
- Getting Started: documentation/analysis/cost_estimation/getting_started.md
- Design Method: documentation/analysis/cost_estimation/operating_cost_method.md
- Run your First Estimation: documentation/analysis/cost_estimation/run_your_first_cost_estimation.md
- Software Architecture: documentation/analysis/cost_estimation/software_architecture.md
- # - API Reference: # TODO define for Python
+ # - API Reference: # TODO define for Python
- Ecological Assessment:
- Introduction: documentation/analysis/ecological_assessment/index.md
- Basic Concepts: documentation/analysis/ecological_assessment/basic-concepts.md
@@ -379,42 +382,48 @@ nav: # Customizes the main navigation struc
- ecological_assessment/namespaces.md
- ecological_assessment/files.md
- ecological_assessment/functions.md
- - Aerodynamic Analysis:
- - Introduction: documentation/analysis/aerodynamic_analysis/getting_started.md
- - Aerodynamic Principles: documentation/analysis/aerodynamic_analysis/aerodynamic_principles.md
- - Software Architecture: documentation/analysis/aerodynamic_analysis/software_architecture.md
- - API Reference:
- - aerodynamic_analysis/classes.md
- - aerodynamic_analysis/namespaces.md
- - aerodynamic_analysis/files.md
- - aerodynamic_analysis/functions.md
- - Constraint Analysis:
- - Introduction: documentation/analysis/constraint_analysis/index.md
- - Principles: documentation/analysis/constraint_analysis/principles.md
+ - Mission Analysis:
+ - Introduction: documentation/analysis/mission_analysis/index.md
+ - Getting Started: documentation/analysis/mission_analysis/getting_started.md
+ - Mission Methods: documentation/analysis/mission_analysis/methods.md
+ - Mission Steps: documentation/analysis/mission_analysis/mission_steps.md
- API Reference:
- - constraint_analysis/classes.md
- - constraint_analysis/namespaces.md
- - constraint_analysis/files.md
- - constraint_analysis/functions.md
+ - mission_analysis/classes.md
+ - mission_analysis/namespaces.md
+ - mission_analysis/files.md
+ - mission_analysis/functions.md
- Performance Assessment:
- Introduction: documentation/analysis/performance_assessment/index.md
- Getting Started: documentation/analysis/performance_assessment/getting_started.md
- - Mission Methods: documentation/analysis/performance_assessment/methods.md
- - Mission Steps: documentation/analysis/performance_assessment/mission_steps.md
+ - Capabilities:
+ - Payload-Range Diagram: documentation/analysis/performance_assessment/payload_range_diagram.md
+ - Takeoff Performance: documentation/analysis/performance_assessment/takeoff_performance.md
+ - Landing Performance: documentation/analysis/performance_assessment/landing_performance.md
+ - Flight Envelope: documentation/analysis/performance_assessment/flight_envelope.md
+ - Ceiling Performance: documentation/analysis/performance_assessment/ceiling_performance.md
- API Reference:
- performance_assessment/classes.md
- performance_assessment/namespaces.md
- performance_assessment/files.md
- performance_assessment/functions.md
+ - Weight and Balance Analysis:
+ - Introduction: documentation/analysis/weight_and_balance_analysis/index.md
+ - Basic Concepts: documentation/analysis/weight_and_balance_analysis/basic-concepts.md
+ - Usage: documentation/analysis/weight_and_balance_analysis/usage.md
+ # - API Reference: # TODO define for Python
- Libraries:
- documentation/libraries/index.md # Link to libraries overview.
- AircraftGeometry2:
- Introduction: documentation/libraries/aircraftGeometry2/index.md
- Getting Started: documentation/libraries/aircraftGeometry2/getting-started.md
- - Tutorial: documentation/libraries/aircraftGeometry2/tutorial.md
+ - Tutorial:
+ - Overview: documentation/libraries/aircraftGeometry2/tutorial.md
+ - Geometry: documentation/libraries/aircraftGeometry2/tutorial-geometry.md
+ - Factory: documentation/libraries/aircraftGeometry2/tutorial-factory.md
+ - Convert: documentation/libraries/aircraftGeometry2/tutorial-convert.md
- engine:
- - Introduction: documentation/libraries/engine/index.md
- - Utilities: documentation/additional_software.md
+ - Introduction: documentation/libraries/engine/index.md
+ - Utilities: documentation/additional-software.md
- Workflow: 'workflow.md' # Link to the workflow page.
- Get Involved:
- Developer Guide: get-involved/developer-installation.md # Top-level item for contributions and development.