From 69d8e238d402091af11ec8673c040cc6812090c7 Mon Sep 17 00:00:00 2001
From: sroscher <s.roscher@tu-berlin.de>
Date: Thu, 30 Jan 2025 15:27:39 +0100
Subject: [PATCH] run_your_first_design.md: - Edited some formatting stuff
---
.../landing_gear_design/run_your_first_design.md | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/docs/documentation/sizing/landing_gear_design/run_your_first_design.md b/docs/documentation/sizing/landing_gear_design/run_your_first_design.md
index aa5198a..0a15ead 100644
--- a/docs/documentation/sizing/landing_gear_design/run_your_first_design.md
+++ b/docs/documentation/sizing/landing_gear_design/run_your_first_design.md
@@ -3,6 +3,7 @@ Let's dive into the fun part and design a landing gear!
## Tool single execution
The tool can be executed from the console directly if all paths are set. The following will happen:
+
- [Console output](#console-output)
- [Generation of reports and plots](#reporting)
- [Writing output to aircraft exchange file](#acxml)
@@ -98,9 +99,10 @@ Finally, you receive information about the reports and plots created (depending
### Reporting {#reporting}
In the following, a short overview is given on the generated reports:
+
- A `landing_gear_design.log` file is written within the directory of the executable
- Depending on your settings, the following output is generated and saved in the `reporting` folder, located in the directory of the aircraft exchange file:
- - an HTML report in the `report_html` folder (not implemented yet)
+ - an HTML report in the `report_html` folder
- a TeX report in the `report_tex` folder (not implemented yet)
- an XML file with additional output data in the `report_xml` folder
- plots in the `plots` folder
@@ -115,16 +117,14 @@ Aircraft exchange file
|- Component design
| |- Landing gear
| | |- Position*
-| | |- Mass properties
-| | | |- ...
+| | |- Mass properties**
| | |- Aircraft classification number
| | |- Specific
| | | |- Geometry
| | | | |- Landing gear assembly (ID="0")
| | | | | |- Name
| | | | | |- Position*
-| | | | | |- Mass properties
-| | | | | | |- ...
+| | | | | |- Mass properties**
| | | | | |- Assembly components
| | | | | | |- Strut diameter
| | | | | | |- Strut length
@@ -134,7 +134,9 @@ Aircraft exchange file
| | | | | | | |- Tire diameter
| | | | | | | |- Tire section width
```
-<sup>*</sup> Node contains the following sub-nodes: x, y, z
+<sup>*</sup> Node was shortened. It contains the following sub-nodes: x, y, z
+
+<sup>**</sup> Node was shortened. It contains sub-nodes with information on the mass, inertia, and center of gravity.
### Generation of geometry file {#existing-geometry-file}
The calculated geometry data is written to the `existing_landing_gear_geometry.xml` file and can then be used if the `use_existing_geometry` flag is set to `true`.
--
GitLab