diff --git a/docs/documentation/sizing/fuselage_design/run_your_first_design.md b/docs/documentation/sizing/fuselage_design/run_your_first_design.md index 4e69db70adbb97fcaec8a962985f2a35ac160a81..dd48fd4be035b7cf9b80a8adaf7269a3ee14f002 100644 --- a/docs/documentation/sizing/fuselage_design/run_your_first_design.md +++ b/docs/documentation/sizing/fuselage_design/run_your_first_design.md @@ -3,6 +3,7 @@ Let's dive into the fun part and design a fuselage! ## 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) @@ -50,9 +51,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 `fuselage_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 @@ -67,16 +69,14 @@ Aircraft exchange file |- Component design | |- Fuselage | | |- Position* -| | |- Mass properties -| | | |- ... +| | |- Mass properties** | | |- Specific | | | |- Geometry | | | | |- Fuselage (ID="0") | | | | | |- Name | | | | | |- Position* | | | | | |- Direction* -| | | | | |- Mass properties -| | | | | | |- ... +| | | | | |- Mass properties** | | | | | |- Sections | | | | | | |- Section (ID="0") | | | | | | | |- Name @@ -134,7 +134,9 @@ Aircraft exchange file | | | | | | | | | |- Payload deck required galley power ``` -<sup>*</sup> Node contains the following sub-nodes: x, y, z +<sup>*</sup> Node has been shortened. It contains the following sub-nodes: x, y, z + +<sup>*</sup> Node has been shortened. It contains sub-nodes with information on the mass, inertia, and center of gravity. ### Write geometry data to .json file {#geometry-data} The calculated geometry data is written to the `fuselage_design_ellipses.json` file and can then be used if the `use_existing_geometry` flag is set to `true`.