From 2de50543891ec2fb54b78e4e93a19302bd7614fb Mon Sep 17 00:00:00 2001
From: sroscher <s.roscher@tu-berlin.de>
Date: Tue, 4 Feb 2025 10:17:31 +0100
Subject: [PATCH] Updated naming of "getting-started.md" files for all TUB LB
Python modules
---
...{getting-started.md => getting_started.md} | 0
.../cost_estimation/software_architecture.md | 34 +++++++++++++++++++
...{getting-started.md => getting_started.md} | 0
...{getting-started.md => getting_started.md} | 0
...{getting-started.md => getting_started.md} | 0
mkdocs.yml | 11 +++---
6 files changed, 40 insertions(+), 5 deletions(-)
rename docs/documentation/analysis/cost_estimation/{getting-started.md => getting_started.md} (100%)
create mode 100644 docs/documentation/analysis/cost_estimation/software_architecture.md
rename docs/documentation/sizing/fuselage_design/{getting-started.md => getting_started.md} (100%)
rename docs/documentation/sizing/landing_gear_design/{getting-started.md => getting_started.md} (100%)
rename docs/documentation/sizing/tank_design/{getting-started.md => getting_started.md} (100%)
diff --git a/docs/documentation/analysis/cost_estimation/getting-started.md b/docs/documentation/analysis/cost_estimation/getting_started.md
similarity index 100%
rename from docs/documentation/analysis/cost_estimation/getting-started.md
rename to docs/documentation/analysis/cost_estimation/getting_started.md
diff --git a/docs/documentation/analysis/cost_estimation/software_architecture.md b/docs/documentation/analysis/cost_estimation/software_architecture.md
new file mode 100644
index 0000000..b947e4a
--- /dev/null
+++ b/docs/documentation/analysis/cost_estimation/software_architecture.md
@@ -0,0 +1,34 @@
+# Software architecture
+This site is currently under development. :construction:
+
+<!--
+## Module structure
+'main.py' runs the following functions:
+1. 'data_preprocessing' (from 'datapreprocessing.py')<sup>1</sup>
+ - 1.1
+2. 'run_module' (from 'methodexecutionpackage' library)<sup>2</sup>
+ - 2.1
+3. 'data_postprocessing' (from 'datapostprocessing.py')<sup>3</sup>
+
+<sup>1</sup> data preprocessing runs: \
+<sup>2</sup> \
+<sup>3</sup> data_postprocessing runs: ...
+
+...
+
+
+### Routing layers
+The tank design module has the following layer structure:
+
+1. Aircraft configuration
+ - Implemented: 'tube_and_wing'
+ - Not yet implemented: 'blended_wing_body'
+2. Calculation method fidelity
+ - Implemented: 'empirical'
+3. Calculation method
+ - Implemented: 'tank_design_tu_berlin'
+4. Energy carrier <sup>1</sup>
+ - Implemented: 'kerosene'
+ - Not yet implemented: 'liquid_hydrogen', 'hybrid'
+
+<sup>1</sup> The used energy carrier is determined automatically in the 'read_energy_carrier_and_tank_configuration' function. -->
diff --git a/docs/documentation/sizing/fuselage_design/getting-started.md b/docs/documentation/sizing/fuselage_design/getting_started.md
similarity index 100%
rename from docs/documentation/sizing/fuselage_design/getting-started.md
rename to docs/documentation/sizing/fuselage_design/getting_started.md
diff --git a/docs/documentation/sizing/landing_gear_design/getting-started.md b/docs/documentation/sizing/landing_gear_design/getting_started.md
similarity index 100%
rename from docs/documentation/sizing/landing_gear_design/getting-started.md
rename to docs/documentation/sizing/landing_gear_design/getting_started.md
diff --git a/docs/documentation/sizing/tank_design/getting-started.md b/docs/documentation/sizing/tank_design/getting_started.md
similarity index 100%
rename from docs/documentation/sizing/tank_design/getting-started.md
rename to docs/documentation/sizing/tank_design/getting_started.md
diff --git a/mkdocs.yml b/mkdocs.yml
index a2003c7..1a97784 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -209,7 +209,7 @@ nav: # Customizes the main navigation struc
- initial_sizing/functions.md
- Fuselage Design:
- Introduction: documentation/sizing/fuselage_design/index.md
- - Getting Started: documentation/sizing/fuselage_design/getting-started.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
@@ -238,7 +238,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
@@ -261,7 +261,7 @@ nav: # Customizes the main navigation struc
- 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
+ - 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
@@ -285,9 +285,10 @@ nav: # Customizes the main navigation struc
# # - API Reference: # TODO define for Python
- Cost Estimation:
- Introduction: documentation/analysis/cost_estimation/index.md
- - Getting Started: documentation/analysis/cost_estimation/getting-started.md
- - Methods: documentation/analysis/cost_estimation/operating_cost_method.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
- Ecological Assessment:
- Introduction: documentation/analysis/ecological_assessment/index.md
--
GitLab