From c154ee513455bbe50a117275aeb9918c4d9b6fcf Mon Sep 17 00:00:00 2001
From: Kristina Mazur <kristina.mazur@tum.de>
Date: Wed, 13 Nov 2024 07:57:08 +0100
Subject: [PATCH] Change title in overview, change libaries list and adapt css
---
docs/assets/css/unicado.css | 8 ++
.../images/documentation/aircraft-network.svg | 19 ----
docs/assets/images/documentation/airfoil.svg | 38 ++++++++
.../images/documentation/pymodulepackage.svg | 13 +++
docs/assets/images/documentation/spline.svg | 19 ----
docs/documentation/analysis.md | 90 +++++++++----------
docs/documentation/libraries.md | 67 ++++----------
docs/documentation/sizing.md | 69 +++++++-------
8 files changed, 158 insertions(+), 165 deletions(-)
delete mode 100644 docs/assets/images/documentation/aircraft-network.svg
create mode 100644 docs/assets/images/documentation/airfoil.svg
create mode 100644 docs/assets/images/documentation/pymodulepackage.svg
delete mode 100644 docs/assets/images/documentation/spline.svg
diff --git a/docs/assets/css/unicado.css b/docs/assets/css/unicado.css
index 96cf6c5..8837256 100644
--- a/docs/assets/css/unicado.css
+++ b/docs/assets/css/unicado.css
@@ -105,6 +105,14 @@
color: var(--secondary-accent); /* Teal accent color for specific elements */
}
+.overview-item {
+ min-height: 240px;
+}
+
+.overview-img {
+ width: 200px;
+}
+
/* Footer Styling */
.custom-footer {
display: flex;
diff --git a/docs/assets/images/documentation/aircraft-network.svg b/docs/assets/images/documentation/aircraft-network.svg
deleted file mode 100644
index b3fcc19..0000000
--- a/docs/assets/images/documentation/aircraft-network.svg
+++ /dev/null
@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
-
-<svg
- width="1080"
- height="1080"
- viewBox="0 0 1080 1080"
- version="1.1"
- id="svg1"
- xml:space="preserve"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:svg="http://www.w3.org/2000/svg"><defs
- id="defs1" /><path
- d="m 328.09193,181.23128 c 0,-51.93088 44.03495,-142.27846 97.18059,-142.27846 54.66408,0 97.18059,90.34758 97.18059,142.27846 V 281.9043 l 269.97984,179.93594 c 13.51418,8.95884 21.56195,24.14331 21.56195,40.39069 v 86.09593 c 0,16.55107 -16.24739,28.24311 -32.03923,23.08039 L 522.45311,524.85579 v 121.47574 l 87.46254,65.5969 c 6.07379,4.55534 9.71806,11.84388 9.71806,19.43612 v 63.77476 c 0,11.84389 -9.56622,21.25826 -21.25826,21.25826 -1.97398,0 -3.94796,-0.30369 -5.92194,-0.75923 L 425.27252,767.80727 258.09153,815.63834 c -1.97398,0.60738 -3.94796,0.75923 -5.92194,0.75923 -11.84389,0 -21.25826,-9.56622 -21.25826,-21.25826 v -63.77476 c 0,-7.59224 3.64428,-14.88078 9.71806,-19.43612 l 87.46254,-65.5969 V 524.85579 L 68.589377,611.40725 C 52.797531,616.56997 36.55015,604.87793 36.55015,588.32686 v -86.09593 c 0,-16.24738 8.047768,-31.43185 21.561945,-40.39069 L 328.09193,281.9043 Z"
- id="path1-3"
- style="fill:#494949;fill-opacity:1;stroke:#ffffff;stroke-width:21.2583;stroke-dasharray:none;stroke-opacity:1" /><path
- d="m 700.49685,447.49479 c -35.10405,0 -63.25052,28.14649 -63.25052,63.25052 v 94.87578 c 0,35.10404 28.14647,63.25052 63.25052,63.25052 h 31.62526 v 63.25052 H 447.49477 v 63.25052 h 126.50104 v 63.25052 h -31.62527 c -35.10403,0 -63.25052,28.14648 -63.25052,63.25052 v 94.87581 c 0,35.104 28.14649,63.2505 63.25052,63.2505 h 126.50105 c 35.10403,0 63.25052,-28.1465 63.25052,-63.2505 v -94.87581 c 0,-35.10404 -28.14649,-63.25052 -63.25052,-63.25052 H 637.24633 V 795.37265 H 890.2484 v 63.25052 h -31.62525 c -35.10404,0 -63.25052,28.14648 -63.25052,63.25052 v 94.87581 c 0,35.104 28.14648,63.2505 63.25052,63.2505 h 126.50106 c 35.10399,0 63.25049,-28.1465 63.25049,-63.2505 v -94.87581 c 0,-35.10404 -28.1465,-63.25052 -63.25049,-63.25052 H 953.49892 V 795.37265 H 1080 V 732.12213 H 795.37263 v -63.25052 h 31.62525 c 35.10404,0 63.25052,-28.14648 63.25052,-63.25052 v -94.87578 c 0,-35.10403 -28.14648,-63.25052 -63.25052,-63.25052 H 700.49685 m 0,63.25052 h 126.50103 v 94.87578 H 700.49685 V 510.74531 M 542.37054,921.87369 h 126.50105 v 94.87581 H 542.37054 v -94.87581 m 316.25261,0 h 126.50106 v 94.87581 H 858.62315 Z"
- id="path1-6"
- style="display:inline;stroke-width:31.6253;fill:#00138e;fill-opacity:1" /></svg>
diff --git a/docs/assets/images/documentation/airfoil.svg b/docs/assets/images/documentation/airfoil.svg
new file mode 100644
index 0000000..29976ff
--- /dev/null
+++ b/docs/assets/images/documentation/airfoil.svg
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+ width="1080"
+ height="1080"
+ viewBox="0 0 1080 1080"
+ version="1.1"
+ id="svg1"
+ xml:space="preserve"
+ sodipodi:docname="airfoil.svg"
+ inkscape:version="1.3.2 (091e20e, 2023-11-25, custom)"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:svg="http://www.w3.org/2000/svg"><sodipodi:namedview
+ id="namedview1"
+ pagecolor="#ffffff"
+ bordercolor="#666666"
+ borderopacity="1.0"
+ inkscape:showpageshadow="2"
+ inkscape:pageopacity="0.0"
+ inkscape:pagecheckerboard="0"
+ inkscape:deskcolor="#d1d1d1"
+ inkscape:zoom="0.93981481"
+ inkscape:cx="539.46798"
+ inkscape:cy="540"
+ inkscape:window-width="2400"
+ inkscape:window-height="1271"
+ inkscape:window-x="2391"
+ inkscape:window-y="-9"
+ inkscape:window-maximized="1"
+ inkscape:current-layer="svg1" /><defs
+ id="defs1" /><path
+ style="fill:none;stroke:#000000;stroke-width:25;stroke-linecap:butt;stroke-linejoin:miter;stroke-dasharray:none;stroke-opacity:1"
+ d="M 1049.1429,950.1872 C 731.41522,341.03307 259.88089,177.05321 296.867,191.5271 c 0,0 -64.37885,-18.78533 -109.59606,-18.08867 -45.21722,0.69665 -99.148933,17.5084 -124.492615,58.52216 -43.775502,103.0815 -23.519286,142.83581 67.034485,183.01478 90.55377,40.17897 286.27101,104.0098 411.78325,164.92611 212.49543,103.93765 346.87501,243.02744 507.54684,370.28572 z"
+ id="path1"
+ sodipodi:nodetypes="cczczcc" /></svg>
diff --git a/docs/assets/images/documentation/pymodulepackage.svg b/docs/assets/images/documentation/pymodulepackage.svg
new file mode 100644
index 0000000..6055f3e
--- /dev/null
+++ b/docs/assets/images/documentation/pymodulepackage.svg
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 40 40">
+ <rect x="10" y="0" width="20" height="40" rx="10" ry="5" mask="url(#lines)"/>
+ <rect x="0" y="10" width="40" height="20" rx="5" ry="10" mask="url(#lines)"/>
+ <circle cx="14.5" cy="5" r="1.85" fill="white" />
+ <circle cx="25.5" cy="35" r="1.85" fill="white" />
+ <mask id="lines">
+ <rect id="bg" x="0" y="0" width="100%" height="100%" fill="white"/>
+ <line x1="10" y1="9.5" x2="20" y2="9.5" stroke="black" />
+ <line x1="20" y1="30.5" x2="30" y2="30.5" stroke="black" />
+ <path d="m 9.5,30 c 0,-10 2.5,-10 10,-10 8.5,0 11,0 11,-10" stroke="black" fill="none" />
+ </mask>
+</svg>
\ No newline at end of file
diff --git a/docs/assets/images/documentation/spline.svg b/docs/assets/images/documentation/spline.svg
deleted file mode 100644
index 58eb58e..0000000
--- a/docs/assets/images/documentation/spline.svg
+++ /dev/null
@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!-- Created with Inkscape (http://www.inkscape.org/) -->
-
-<svg
- width="1080"
- height="1080"
- viewBox="0 0 1080 1080"
- version="1.1"
- id="svg1"
- xml:space="preserve"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:svg="http://www.w3.org/2000/svg"><defs
- id="defs1" /><path
- d="M 735.81276,814.03713 V 1064.3552 H 485.49477 V 814.03713 H 735.81276 M 767.10251,454.20502 939.19614,735.81276 H 595.00889 L 767.10251,454.20502 M 939.19614,798.39226 C 1017.4205,798.39226 1080,860.97177 1080,939.19614 1080,1017.4206 1017.4205,1080 939.19614,1080 c -78.22437,0 -140.80388,-62.5795 -140.80388,-140.80386 0,-78.22437 62.57951,-140.80388 140.80388,-140.80388 z"
- id="path1-9"
- style="fill:#2ac61c;fill-opacity:1;stroke-width:31.2898" /><path
- d="m 842.88967,9.9431109 a 75.722413,75.722413 0 0 1 75.72244,75.7224021 75.722413,75.722413 0 0 1 -75.72244,75.722417 c -11.61079,0 -22.71674,-2.52407 -32.81305,-7.57223 l -186.27714,186.78195 17.16374,22.71673 C 751.51794,299.70754 881.2557,262.35115 1019.5753,262.35115 l 50.4816,1.51444 v 101.46806 l -50.4816,-2.01927 c -130.24256,0 -252.40806,37.86119 -353.37127,102.98248 A 199.90718,199.90718 0 0 1 466.29686,666.20403 C 401.17557,767.16724 363.31438,889.33274 363.31438,1019.5753 l 2.01927,50.4816 H 263.86559 l -1.51444,-50.4816 c 0,-138.3196 37.35639,-268.05736 100.96323,-378.61208 L 340.59765,623.79948 153.8157,810.07662 c 5.04816,10.09631 7.57223,21.20226 7.57223,32.81305 A 75.722413,75.722413 0 0 1 85.665513,918.61211 75.722413,75.722413 0 0 1 9.9431109,842.88967 75.722413,75.722413 0 0 1 85.665513,767.16724 c 11.61079,0 22.716737,2.52407 32.813067,7.57224 L 304.7557,587.95753 C 278.00046,554.13486 262.35115,510.72068 262.35115,464.27759 A 201.92645,201.92645 0 0 1 464.27759,262.35115 c 46.44309,0 89.85727,15.64931 123.67994,42.40455 L 774.73948,118.47858 c -5.04817,-10.09633 -7.57224,-21.202277 -7.57224,-32.813067 A 75.722413,75.722413 0 0 1 842.88967,9.9431109 M 464.27759,363.31438 A 100.96321,100.96321 0 0 0 363.31438,464.27759 100.96321,100.96321 0 0 0 464.27759,565.2408 100.96321,100.96321 0 0 0 565.2408,464.27759 100.96321,100.96321 0 0 0 464.27759,363.31438 Z"
- id="path1"
- style="fill:#4d4d4d;fill-opacity:1;stroke:#ffffff;stroke-width:19.8862;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" /></svg>
diff --git a/docs/documentation/analysis.md b/docs/documentation/analysis.md
index 33ddb63..c8f59de 100644
--- a/docs/documentation/analysis.md
+++ b/docs/documentation/analysis.md
@@ -10,41 +10,41 @@ glightbox: false
---
-## calculateEmissions
-{.overview-img align=left}
-The **calculateEmissions** is an additional module of the UNICADO toolchain.
-Its purpose is to calculate the emissions and energy demand within the aircraft's lifecycle and to determine the missions based climate impact.
-For the user, possible changes in the module run configuration can be made in the related calculateEmissions_conf.xml file.
-The parameters comprised in this XML file can have different attributes as e.g. Filenames, Directories, Output configs, and are further subdivided into control and program settings.
+## Aerodynamic analysis
+{.overview-img align=left}
+The tool `aerodynamic_analysis` calculates, as the tool name suggests, the polars of an aircraft.
+It uses the tool Lifting Line from DLR to calculate force, lift and moment coefficients for each lifting surface of the aircraft.
+These coefficients are used to calculate induced, viscous and wave drag as well as the moment coefficients for the overall aircraft.
+Furthermore polars are not only calculated for off-design mach numbers but also for high
+lift mach numbers.
{.overview-item}
-!!! note
- By now, only the calculation routines / outputs based on the flown mission are up to date.
-
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
---
-## calculatePerformance
-{.overview-img align=left}
-The module `calculatePerformance` is used to evaluate the mission performance of the design.
-{.overview-item}
+## 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)
+
+For the user, possible changes in the module run configuration can be made in the related *missionAnalysis_conf.xml* file. The parameters comprised in this XML file can have different attributes as e.g. Desc, Unit, Default, AllowedRelOvershoot or text and are further subdivided into control and program settings.
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus:| GPLv3 |[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
---
-## calculatePolar
-{.overview-img align=left}
-The tool `calculatePolar` calculates, as the tool name suggests, the polars of an aircraft.
-CalculatePolar uses the tool Lifting Line from DLR to calculate force, lift and moment coefficients for each lifting surface of the aircraft.
-These coefficients are used to calculate induced, viscous and wave drag as well as the moment coefficients for the overall aircraft.
-Furthermore polars are not only calculated for off-design mach numbers but also for high
-lift mach numbers.
+## 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|
@@ -53,46 +53,46 @@ lift mach numbers.
---
-## costEstimation
-{.overview-img align=left}
-This modules calculates the direct operating cost (DOC) of an aircraft.
-Direct costs include all expenses incurred in operating and financing the aircraft:
+## Ecological assessment
+{.overview-img align=left}
+The **ecological_assessment** is an additional module of the UNICADO toolchain.
+Its purpose is to calculate the emissions and energy demand within the aircraft's lifecycle and to determine the missions based climate impact.
+For the user, possible changes in the module run configuration can be made in the related calculateEmissions_conf.xml file.
+The parameters comprised in this XML file can have different attributes as e.g. Filenames, Directories, Output configs, and are further subdivided into control and program settings.
+{.overview-item}
-- Fuel
-- Crew
-- Maintenance
-- Fees
+!!! note
+ By now, only the calculation routines / outputs based on the flown mission are up to date.
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-python: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
---
-## massEstimation
-{.overview-img align=left}
-The Mass Estimation module calculates sub-masses and total masses of the aircraft including center of gravities.
+## 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|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus:| GPLv3 |[Link]()|
---
-## missionAnalysis
-{.overview-img align=left}
-The module `missionAnalysis` 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)
+## Cost estimation
+{.overview-img align=left}
+This modules calculates the direct operating cost (DOC) of an aircraft.
+Direct costs include all expenses incurred in operating and financing the aircraft:
-For the user, possible changes in the module run configuration can be made in the related *missionAnalysis_conf.xml* file. The parameters comprised in this XML file can have different attributes as e.g. Desc, Unit, Default, AllowedRelOvershoot or text and are further subdivided into control and program settings.
+- Fuel
+- Crew
+- Maintenance
+- Fees
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-python: |GPLv3|[Link]()|
----
\ No newline at end of file
+---
diff --git a/docs/documentation/libraries.md b/docs/documentation/libraries.md
index 6cc3952..d03c98a 100644
--- a/docs/documentation/libraries.md
+++ b/docs/documentation/libraries.md
@@ -19,29 +19,8 @@ It has helper functions to extract and interpolate data of provided airfoil pola
---
-## aircraftGeometry
-{.overview-img align=left}
-This library defines geometry classes which are generally used within an aircraft.
-The geometry describes the general shape of the different components.
-The available components are:
-
-- *liftingSurface*
-- *verticalSurface*
-- *Fuselage*
-- *Nacelle*
-- *Pylon*
-- *Landing Gear*
-
-The library furthermore provides functions to extract and measure geometry properties of the different shapes at certain locations.
-
-|Module Version|Language|License|Documentation|Dependencies|
-|:---:|:---:|:---:|---|---|
-|2.0.0|:simple-cplusplus: |GPLv3|[Link]()|-|
-
----
-
## aircraftGeometry2
-{.overview-img align=left}
+{.overview-img align=left}
This library is based on the older [aircraftGeometry](#aircraftgeometry) library and extends it to be more modular.
The modularity and flexibility is achieved by using the high performance [Computational Geometry Algorithms Library](https://www.cgal.org/) also known as **CGAL**.
{.overview-item}
@@ -52,15 +31,14 @@ The modularity and flexibility is achieved by using the high performance [Comput
---
-## aircraftNetwork
-{.overview-img align=left}
-This library can be used to define wiring harnesses within an existing aircraft geometry.
-You can route wire through different points and analyse the resulting network.
+## airfoils
+{.overview-img align=left}
+The **airfoils** libary provides a database for different airfoils.
{.overview-item}
|Module Version|Language|License|Documentation|Dependencies|
|:---:|:---:|:---:|---|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-|
+|1.0.0|:simple-cplusplus: |GPLv3|[Link]()|-|
---
@@ -112,6 +90,14 @@ The engine decks can originate from different softwaretools as long as they prov
---
+## extern
+UNICADO currently uses two external libaries as submodules:
+
+- `doxygen-awesome-css` [(see here)](https://github.com/jothepro/doxygen-awesome-css.git)
+- `pybind11` [(see here)](https://github.com/pybind/pybind11.git)
+
+---
+
## liftingLineInterface
{.overview-img align=left}
This library helps with interacting with results provided by the tools **Lifting Line** from DLR.
@@ -137,20 +123,14 @@ The library gives a template how modules should be structured and gives helpers
---
-## propulsionsystem
-{.overview-img align=left}
-This is a versatile tool which can be used to simulate and analyse the power flow within an aircraft.
-The power flow is mainly determined by the propulsive systems onboard, but the tool can account for other power needed during operation as well.
-The propulsion systems are not limited to conventional types.
-Due to the flexible abstraction via so-called *two-terminal block*, any system which as inputs and outputs can be implemented.
+## pymodulepackage
+{.overview-img align=left}
+This library provides standardized UNICADO data preprocessing, run, and postprocessing functions for Python modules.
{.overview-item}
|Module Version|Language|License|Documentation|Dependencies|
|:---:|:---:|:---:|---|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-|
-
-!!! info
- Since this is a standalone tool it will most likely move to another repository in the next release.
+|1.0.0|:simple-python: |GPLv3|[Link]()|-|
---
@@ -166,17 +146,6 @@ In provides custom output streams, which automatically handle the log files and
---
-## spline
-{.overview-img align=left}
-The name gives it away: this library provides spline functionality for interpolating data or geometry.
-{.overview-item}
-
-|Module Version|Language|License|Documentation|Dependencies|
-|:---:|:---:|:---:|---|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-|
-
----
-
## standardFiles
{.overview-img align=left}
This library provides file interfaces and interacts with the operating system.
@@ -205,6 +174,8 @@ You can insert text and measurements for quickly creating meaningful reports.
---
+[comment]: <> (## svl)
+
## unitConversion
{.overview-img align=left}
The **unitConversion** groups the most commonly used unit in aerospace and let's you convert values from one unit to another.
diff --git a/docs/documentation/sizing.md b/docs/documentation/sizing.md
index 8d36fc2..91b4857 100644
--- a/docs/documentation/sizing.md
+++ b/docs/documentation/sizing.md
@@ -14,12 +14,11 @@ The following sizing tools are available:
---
-## createMissionXML
-{.overview-img align=left}
-The **createMissionXML** is the third module of the UNICADO tool chain.
-Its purpose is to set up the overall flight mission including e.g. a flight segment table, speed and altitude schedules, number of passengers (PAX), total payload or the engine warm up time.
-For the user, possible changes in the module run configuration can be made in the related createMissionXML_conf.xml file.
-The parameters comprised in this file can have different attributes as e.g. Desc, Unit, Default or #text and are further subdivided into control settings and program settings.
+## 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|
@@ -28,10 +27,12 @@ The parameters comprised in this file can have different attributes as e.g. Desc
---
-## empennageSizing
-{.overview-img align=left}
-The **empennageSizing** 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.
+## Create mission XML
+{.overview-img align=left}
+The **create_mission_XML** is the third module of the UNICADO tool chain.
+Its purpose is to set up the overall flight mission including e.g. a flight segment table, speed and altitude schedules, number of passengers (PAX), total payload or the engine warm up time.
+For the user, possible changes in the module run configuration can be made in the related createMissionXML_conf.xml file.
+The parameters comprised in this file can have different attributes as e.g. Desc, Unit, Default or #text and are further subdivided into control settings and program settings.
{.overview-item}
|Module Version|Language|License|Documentation|
@@ -40,9 +41,9 @@ It takes takes the controllability as wells as the static margin of the aircraft
---
-## fuselageDesign
+## Fuselage design
{.overview-img align=left}
-The **fuselageDesign** module calculates characteristic parameters and generates the passenger cabin and fuselage layout for the entire aircraft project.
+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|
@@ -51,22 +52,21 @@ The **fuselageDesign** module calculates characteristic parameters and generates
---
-## hydrogenTank
-{.overview-img align=left}
-:construction: *tbd*
+## 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-python: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
---
-## initialSizing
-{.overview-img align=left}
-The module **initialSizing** 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.
+## 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|
@@ -75,18 +75,19 @@ Furthermore an initial estimation of the takeoff mass is done.
---
-## landingGearDesign
-{.overview-img align=left}
-The **landingGearDesign** module calculates characteristic parameters for the landing gear of entire aircraft project.
+## Tank design
+{.overview-img align=left}
+:construction: *tbd*
{.overview-item}
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-python: |GPLv3|[Link]()|
+
---
-## propulsionDesign
+## Propulsion design
{.overview-img align=left}
The **propulsionDesign** module designs, integrates and analyzes the propulsion system to the aircraft.
It uses engine performance deck containing serval parameters (like thrust, fuel-flow, ...) as a function of the flight Mach number and the altitude.
@@ -103,10 +104,9 @@ Also the mass properties are analyzed.
---
-## systemsDesign
-{.overview-img align=left}
-The **systemsDesign** 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.
+## 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|
@@ -115,13 +115,14 @@ It dimensions ATA chapter systems in terms of mass and energy requirement divide
---
-## wingDesign
-{.overview-img align=left}
-The wing design module calculates characteristic parameter of the aircraft main wing.
+## 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]()|
----
\ No newline at end of file
+---
--
GitLab