Skip to content
Snippets Groups Projects
Commit 3000887a authored by sroscher's avatar sroscher
Browse files

getting-started.md: Renamed file to "getting_started.md" to keep file naming consistent

mkdocs.yml: Changed naming of getting_started.md accordingly
parent 1ce32a2c
Branches
No related tags found
No related merge requests found
Pipeline #1601957 waiting for manual action
......@@ -12,9 +12,11 @@ This section will guide you through the necessary steps to get the _tank\_design
It is assumed that you have the `UNICADO package` installed including the executables and UNICADO libraries.
Generally, we use two files to set or configure modules in UNICADO:
- The aircraft exchange file (or _acXML_) includes
- data related inputs (e.g., required energy, component design data) and
- data related outputs (e.g., tank positions).
- The module configuration file `tank_design_conf.xml` (also _configXML_) includes
- control settings (e.g., enable/disable generating plots) and
- program settings (e.g., information on buffers).
......@@ -37,12 +39,26 @@ Thus, it must be ensured that this data is available. More information on requir
## Aircraft exchange file requirements {#aircraft-exchange-file}
To single execute the _tank\_design_ module, we need an _acXML_ file that already contains the output data from the following tools:
- _wing\_design_
- _empennage\_design_
- _fuselage\_design_
- _mission\_analysis_ - _tank\_design_ execution also possible without mission analysis data (an assumption is made to calculate mission energy amount)
- _mission\_analysis_ <sup>*</sup>
<sup>*</sup> The _tank\_design_ execution is also possible without mission analysis data. Alternatively, the following assumption is used to calculate the mission fuel amount:
$
m_{fuel} = n_{PAX} \cdot R \cdot \frac{E}{100 \text{ km}}
$
In which
- $n_{PAX}$ - number of passengers
- $R$ - range in km
- $E$ - energy demand (3.35 liter per PAX per 100 km)
The following data should then be available in the _acXML_:
1. Requirements and specifications
- Design specification
- Configuration information: Configuration type, tank definition ([see below](#configuring-tank-design-parameters-in-the-aircraft-exchange-file))
......
......@@ -235,7 +235,7 @@ nav: # Customizes the main navigation struc
- empennage_design/functions.md
- Tank Design:
- Introduction: documentation/sizing/tank_design/index.md
- Getting Started: documentation/sizing/tank_design/getting-started.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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment