diff --git a/docs/modules/libraries.md b/docs/modules/libraries.md index c5a8d6642d29e5fe5519687755f67df919182a50..8471e400edd9eb8b4b6b7f6d1cf9eaaacf782217 100644 --- a/docs/modules/libraries.md +++ b/docs/modules/libraries.md @@ -13,9 +13,9 @@ This library helps with interacting with polar data. It has helper functions to extract and interpolate data of provided airfoil polars. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -34,9 +34,9 @@ The available components are: The library furthermore provides functions to extract and measure geometry properties of the different shapes at certain locations. -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.0.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.0.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -46,9 +46,9 @@ This library is based on the older [aircraftGeometry](#aircraftgeometry) library The modularity and flexibility is achieved by using the high performance [Computational Geometry Algorithms Library](https://www.cgal.org/) also known as **CGAL**. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link](aircraftGeometry2/index.html)| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link](aircraftGeometry2/index.html)| [Eigen3](https://eigen.tuxfamily.org/index.php?title=Main_Page), [CGAL](https://www.cgal.org/)| --- @@ -58,9 +58,9 @@ This library can be used to define wiring harnesses within an existing aircraft You can route wire through different points and analyse the resulting network. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -70,9 +70,9 @@ The **aixml** library is the central library which handles the XML files and dat It uses a simple XML library, namely *tinyxml*, to read and parse the XML files. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -82,9 +82,9 @@ The **atmosphere** library provides helper functions to calculate atmospheric pr You can set different atmospheric conditions (e.g. *ISA+25*) and calculate the physical properties of the air at different altitudes. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -95,9 +95,9 @@ It has helper functions to extract and interpolate data of provided engine data The engine decks can originate from different softwaretools as long as they provide the same file format. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -107,9 +107,9 @@ This library helps with interacting with results provided by the tools **Lifting It has helper functions to extract and interpolate data of the results from the tool. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -120,9 +120,9 @@ The tools are intended to follow the *Strategy Design Pattern* to execute at dif The library gives a template how modules should be structured and gives helpers which can be used to select and implement the different fidelity methods. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -134,9 +134,9 @@ The propulsion systems are not limited to conventional types. Due to the flexible abstraction via so-called *two-terminal block*, any system which as inputs and outputs can be implemented. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| !!! info Since this is a standalone tool it will most likely move to another repository in the next release. @@ -149,9 +149,9 @@ This library handles the user interface during the modules execution. In provides custom output streams, which automatically handle the log files and error outputs according to the configuration files. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -160,9 +160,9 @@ In provides custom output streams, which automatically handle the log files and The name gives it away: this library provides spline functionality for interpolating data or geometry. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -173,9 +173,9 @@ It can handle process execution with a simple interface. The library can handle *UNIX* and *Windows* systems alike. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| !!! warning Some functions of this library are a bit outdated! When using this library, please look first at the wonderful [STL :octicons-link-external-16:](https://en.cppreference.com/w/) whether the function you are seeking is already there. @@ -188,9 +188,9 @@ This library interact with the shapes defined by [aircraftGeometry](#aircraftgeo You can insert text and measurements for quickly creating meaningful reports. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| --- @@ -200,6 +200,6 @@ The **unitConversion** groups the most commonly used unit in aerospace and let's In addition, it defines some common **constants** which are useful for calculations. {.overview-item} -|Module Version|Language|License|Documentation| -|:---:|:---:|:---:|---| -|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| \ No newline at end of file +|Module Version|Language|License|Documentation|Dependencies| +|:---:|:---:|:---:|---|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|-| \ No newline at end of file