From f2ba203d20190c5a3d4befb89fb47f1000080cf1 Mon Sep 17 00:00:00 2001
From: Kristina Mazur <k.kossarev@googlemail.com>
Date: Thu, 28 Nov 2024 20:36:10 +0100
Subject: [PATCH] Include tool links and minor changes in libraries

---
 docs/assets/images/documentation/svg-plot.svg | 19 -----------
 docs/assets/images/documentation/svl.svg      | 22 ++++++++++++
 docs/documentation/analysis.md                | 15 ++++----
 docs/documentation/libraries.md               | 34 +++++++++++++------
 docs/documentation/sizing.md                  | 20 +++++------
 5 files changed, 63 insertions(+), 47 deletions(-)
 delete mode 100644 docs/assets/images/documentation/svg-plot.svg
 create mode 100644 docs/assets/images/documentation/svl.svg

diff --git a/docs/assets/images/documentation/svg-plot.svg b/docs/assets/images/documentation/svg-plot.svg
deleted file mode 100644
index 8839887..0000000
--- a/docs/assets/images/documentation/svg-plot.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 322.76416,21.555325 C 319.87534,14.622131 313.13473,10 305.62375,10 h -36.59186 c -7.51096,0 -14.44416,4.622131 -17.1404,11.555325 l -39.86587,99.568395 c -6.16284,15.40711 -28.11797,15.40711 -34.28081,0 L 137.87894,21.555325 C 134.99011,14.622131 128.2495,10 120.73854,10 H 102.44261 C 51.406586,10 10,51.406586 10,102.44261 V 503.02725 H 749.54087 V 102.44261 C 749.54087,51.406586 708.13429,10 657.09826,10 H 453.91712 c -7.51098,0 -14.44416,4.622131 -17.14041,11.555325 l -39.86587,99.568395 c -6.16284,15.40711 -28.11797,15.40711 -34.28081,0 z M 10,564.65566 v 61.6284 c 0,67.98384 55.272976,123.25681 123.25681,123.25681 h 123.25681 v 123.25682 c 0,67.98383 55.27297,123.25681 123.25681,123.25681 67.98385,0 123.25682,-55.27298 123.25682,-123.25681 V 749.54087 h 123.25681 c 67.98384,0 123.25681,-55.27297 123.25681,-123.25681 v -61.6284 z m 369.77043,277.32782 a 30.814205,30.814205 0 1 1 0,61.62841 30.814205,30.814205 0 1 1 0,-61.62841 z"
-     id="path1-7"
-     style="fill:#4d4d4d;fill-opacity:1;stroke:#ffffff;stroke-width:20;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" /><path
-     d="m 409.69927,441.54239 v 191.53723 h 94.1725 l 63.84576,191.53744 H 537.39079 V 1016.1542 H 728.92807 V 869.62824 L 901.63086,696.92539 H 1048.157 V 505.38815 H 856.61961 V 651.27568 L 683.91682,824.61706 h -48.842 L 571.22905,633.07962 h 30.0075 V 441.54239 H 409.69927 m 63.84576,63.84576 h 63.84576 v 63.84575 h -63.84576 v -63.84575 m 446.92034,63.84575 h 63.84585 v 63.84572 H 920.46537 V 569.2339 m 100.55713,191.53739 c -4.7885,0 -8.9385,1.59605 -12.4499,5.10756 l -32.24219,32.56134 66.08039,66.08036 32.5613,-32.24209 c 6.7039,-6.70387 6.7039,-18.19605 0,-24.89993 l -41.4997,-41.49968 a 17.366047,17.366047 0 0 0 -12.4499,-5.10756 M 957.17668,816.95551 760.85096,1013.2812 V 1080 h 66.71882 L 1023.5763,883.35501 957.17668,816.95551 M 601.23655,888.4627 h 63.84577 v 63.84576 h -63.84577 z"
-     id="path1"
-     style="fill:#e05200;fill-opacity:1;stroke-width:31.9228" /></svg>
diff --git a/docs/assets/images/documentation/svl.svg b/docs/assets/images/documentation/svl.svg
new file mode 100644
index 0000000..4bc4b59
--- /dev/null
+++ b/docs/assets/images/documentation/svl.svg
@@ -0,0 +1,22 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
+ "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
+ width="1280.000000pt" height="640.000000pt" viewBox="0 0 1280.000000 640.000000"
+ preserveAspectRatio="xMidYMid meet">
+<metadata>
+Created by potrace 1.15, written by Peter Selinger 2001-2017
+</metadata>
+<g transform="translate(0.000000,640.000000) scale(0.100000,-0.100000)"
+fill="#000000" stroke="none">
+<path d="M9280 5934 c-106 -21 -223 -80 -293 -150 -99 -97 -148 -196 -168
+-336 -10 -72 -9 -97 5 -164 22 -108 75 -212 144 -282 33 -33 391 -297 851
+-627 l794 -570 -5084 -5 c-4763 -5 -5087 -6 -5132 -22 -146 -52 -265 -152
+-330 -275 -114 -217 -77 -472 93 -644 70 -71 126 -108 217 -142 l58 -22 5078
+-5 5078 -5 -752 -615 c-414 -338 -776 -638 -804 -667 -29 -29 -68 -84 -89
+-125 -112 -224 -73 -470 105 -649 104 -105 233 -159 382 -159 99 0 186 22 270
+68 70 39 2847 2303 2942 2399 160 162 199 422 93 633 -46 94 -119 163 -324
+311 -1086 782 -2701 1940 -2747 1970 -83 54 -166 80 -272 84 -49 2 -101 1
+-115 -1z"/>
+</g>
+</svg>
diff --git a/docs/documentation/analysis.md b/docs/documentation/analysis.md
index c8f59de..3f9b1e9 100644
--- a/docs/documentation/analysis.md
+++ b/docs/documentation/analysis.md
@@ -3,7 +3,8 @@ title: Analysis
 summary: Overview of the analysis modules of aircraftDesign repository
 authors:
     - Sebastian Oberschwendtner
-date: 2023-09-08
+    - Kristina Mazur
+date: 2024-11-28
 glightbox: false
 ---
 # Analysis Tools
@@ -21,7 +22,7 @@ lift mach numbers.
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](aerodynamic_analysis/index.html)|
 
 ---
 
@@ -38,7 +39,7 @@ For the user, possible changes in the module run configuration can be made in th
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](mission_analysis/index.html)|
 
 ---
 
@@ -49,7 +50,7 @@ The `weight_and_balance_analysis` module calculates sub-masses and total masses
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](weight_and_balance_analysis/index.html)|
 
 ---
 
@@ -66,7 +67,7 @@ The parameters comprised in this XML file can have different attributes as e.g.
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](ecological_assessment/index.html)|
 
 ---
 
@@ -77,7 +78,7 @@ The module `calculatePerformance` is used to evaluate the mission performance of
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus:| GPLv3 |[Link]()|
+|2.1.0|:simple-cplusplus:| GPLv3 |[Link](performance_assessment/index.html)|
 
 ---
 
@@ -93,6 +94,6 @@ Direct costs include all expenses incurred in operating and financing the aircra
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-python: |GPLv3|[Link]()|
+|2.1.0|:simple-python: |GPLv3|[Link](cost_estimation/index.html)|
 
 ---
diff --git a/docs/documentation/libraries.md b/docs/documentation/libraries.md
index 6de44e4..7d02739 100644
--- a/docs/documentation/libraries.md
+++ b/docs/documentation/libraries.md
@@ -3,10 +3,22 @@ title: Libraries
 summary: Overview of the libraries respository
 authors:
     - Sebastian Oberschwendtner
-date: 2023-09-08
+    - Kristina Mazur
+date: 2024-11-28
 glightbox: false
 ---
 
+As mentioned in the [build instructions](../developer/build/general.md), we have some external dependencies to:
+
+- :simple-cplusplus: [Eigen3 :octicons-link-external-16:](https://eigen.tuxfamily.org/index.php?title=Main_Page){:target="_blank"}
+- :simple-cplusplus: [Boost :octicons-link-external-16:](https://www.boost.org/){:target="_blank"}
+- :simple-cplusplus: [CGAL :octicons-link-external-16:](https://www.cgal.org/){:target="_blank"}
+- :simple-python: [pipenv :octicons-link-external-16:](https://pipenv.pypa.io/en/latest/){:target="_blank"} (not really a library, more a environment manager tool)
+
+
+!!! note
+    Currently, only `aircraftGeometry2` and `engine` are documented.
+
 ## aerodynamics
 ![Icon](../assets/images/documentation/aerodynamics.svg){.overview-img  align=left}
 This library helps with interacting with polar data.
@@ -93,8 +105,8 @@ 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)
+- `doxygen-awesome-css` for documentation formation [(see here)](https://github.com/jothepro/doxygen-awesome-css.git)
+- `pybind11` to use C++ libraries in the python tools [(see here)](https://github.com/pybind/pybind11.git)
 
 ---
 
@@ -162,19 +174,19 @@ The library can handle *UNIX* and *Windows* systems alike.
 
 ---
 
-## svgPlot
-![Icon](../assets/images/documentation/svg-plot.svg){.overview-img  align=left}
-This library interact with the shapes defined by [aircraftGeometry](#aircraftgeometry) and can create different views of the shapes in **SVG** format.
-You can insert text and measurements for quickly creating meaningful reports.
+## svl
+![Icon](../assets/images/documentation/svl.svg){.overview-img  align=left}
+The `simple vector library` by Andrew Willmott provides vector and matrix classes.
 {.overview-item}
 
 |Module Version|Language|License|Documentation|Dependencies|
 |:---:|:---:|:---:|---|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-|
+|2.1.0|:simple-cplusplus: | |[Link](https://www.cs.cmu.edu/~ajw/doc/svl.html)|-|
 
----
+!!! note
+    This will soon be replaced by `Eigen`.
 
-[comment]: <> (## svl)
+---
 
 ## unitConversion
 ![Icon](../assets/images/documentation/unit-conversion.svg){.overview-img  align=left}
@@ -184,4 +196,4 @@ In addition, it defines some common **constants** which are useful for calculati
 
 |Module Version|Language|License|Documentation|Dependencies|
 |:---:|:---:|:---:|---|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-|
\ No newline at end of file
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-|
diff --git a/docs/documentation/sizing.md b/docs/documentation/sizing.md
index 91b4857..bdb7997 100644
--- a/docs/documentation/sizing.md
+++ b/docs/documentation/sizing.md
@@ -4,7 +4,7 @@ summary: Overview of the sizing modules of aircraftDesign repository
 authors:
     - Sebastian Oberschwendtner
     - Kristina Mazur
-date: 2024-08-05
+date: 2024-11-28
 glightbox: false
 ---
 # Sizing Tools
@@ -23,7 +23,7 @@ Furthermore an initial estimation of the takeoff mass is done.
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](initial_sizing/index.html)|
 
 ---
 
@@ -37,7 +37,7 @@ The parameters comprised in this file can have different attributes as e.g. Desc
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](create_mission_xml/index.html)|
 
 ---
 
@@ -48,7 +48,7 @@ The **fuselage_design** module calculates characteristic parameters and generate
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](fuselage_design/index.html)|
 
 ---
 
@@ -59,7 +59,7 @@ The **wing_design** module calculates characteristic parameter of the aircraft m
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](wing_design/index.html)|
 
 ---
 
@@ -71,7 +71,7 @@ It takes takes the controllability as wells as the static margin of the aircraft
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](empennage_design/index.html)|
 
 ---
 
@@ -82,7 +82,7 @@ It takes takes the controllability as wells as the static margin of the aircraft
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-python: |GPLv3|[Link]()|
+|2.1.0|:simple-python: |GPLv3|[Link](tank_design/index.html)|
 
 
 ---
@@ -100,7 +100,7 @@ Also the mass properties are analyzed.
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|3.0.0|:simple-cplusplus: |GPLv3|[Link]()|
+|3.0.0|:simple-cplusplus: |GPLv3|[Link](propulsion_design/index.html)|
 
 ---
 
@@ -111,7 +111,7 @@ The **landing_gear_design** module calculates characteristic parameters for the
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](landing_gear_design/index.html)|
 
 ---
 
@@ -123,6 +123,6 @@ It dimensions ATA chapter systems in terms of mass and energy requirement divide
 
 |Module Version|Language|License|Documentation|
 |:---:|:---:|:---:|---|
-|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](systems_design/index.html)|
 
 ---
-- 
GitLab