diff --git a/.gitignore b/.gitignore index 7813adcdf5c621da9cd6aabeed8f92bcfe025fcd..38289921c0f46709a26f1da4b0fbdd3a5745ffb9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ # Ignore generated Doxygen docs in modules folder -/docs/modules/ +/docs/modules/**/ diff --git a/docs/modules/additional-software.md b/docs/modules/additional-software.md new file mode 100644 index 0000000000000000000000000000000000000000..09d7e0a080d62edba3a48e17b996cdb772a10fb3 --- /dev/null +++ b/docs/modules/additional-software.md @@ -0,0 +1,39 @@ +--- +title: Additional Software +summary: Overview of the additionalSoftware repository +authors: + - Sebastian Oberschwendtner +date: 2023-09-08 +glightbox: false +--- +## cpacsInterface +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## designEvaluator +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## reportGenerator +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## testFramework +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| diff --git a/docs/modules/analysis.md b/docs/modules/analysis.md new file mode 100644 index 0000000000000000000000000000000000000000..e7cf74290e8b5df63be8bc56d4c5507aab79ddeb --- /dev/null +++ b/docs/modules/analysis.md @@ -0,0 +1,56 @@ +--- +title: Analysis +summary: Overview of the analysis modules of aircraftDesign repository +authors: + - Sebastian Oberschwendtner +date: 2023-09-08 +glightbox: false +--- + +## calculateEmissions +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## calculatePerformance +{width=200 align=left} +The module `calculatePerformance` is used to evaluate the mission performance of the design. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus:| GPLv3 |[Link]()| + +## calculatePolar +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## costEstimation +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-python: |GPLv3|[Link]()| + +## massEstimation +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## missionAnalysis +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| \ No newline at end of file diff --git a/docs/modules/libraries.md b/docs/modules/libraries.md new file mode 100644 index 0000000000000000000000000000000000000000..2d0a3ab41944e20c625471d18113e08438c2d6e2 --- /dev/null +++ b/docs/modules/libraries.md @@ -0,0 +1,129 @@ +--- +title: Libraries +summary: Overview of the libraries respository +authors: + - Sebastian Oberschwendtner +date: 2023-09-08 +glightbox: false +--- + +## aerodynamics +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## aircraftGeometry +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.0.0|:simple-cplusplus: |GPLv3|[Link]()| + +## aircraftGeometry2 +{width=200 align=left} +This library is based on the older [aircraftGeometry](#aircraftgeometry) library and extends it to be more modular. +The modularity and flexibility is achieved by using the high performance [Computational Geometry Algorithms Library](https://www.cgal.org/) also known as **CGAL**. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link](aircraftGeometry2/index.html)| + +## aircraftNetwork +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## aixml +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## atmosphere +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## engine +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## liftingLineInterface +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## moduleBasics +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## propulsionsystem +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## runtimeInfo +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## spline +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## standardFiles +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## svgPlot +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## unitConversion +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| \ No newline at end of file diff --git a/docs/modules/overview.md b/docs/modules/overview.md new file mode 100644 index 0000000000000000000000000000000000000000..1acc339ece2839efa705056ed3da63c2051954b3 --- /dev/null +++ b/docs/modules/overview.md @@ -0,0 +1,17 @@ +--- +title: Overview +summary: Overview of the software groups. +authors: + - Sebastian Oberschwendtner +date: 2023-09-08 +glightbox: false +--- + +UNICADO collects the following software modules. +The modules are grouped into: + +- **Aircraft Design**: + - [Sizing Tools](sizing.md) + - [Analysis Tools](analysis.md) +- [ Libraries ](libraries.md) +- [Additional Software](additional-software.md) \ No newline at end of file diff --git a/docs/modules/sizing.md b/docs/modules/sizing.md new file mode 100644 index 0000000000000000000000000000000000000000..e49f024f3d2e3516d7c951718c3eb26adbdbcd88 --- /dev/null +++ b/docs/modules/sizing.md @@ -0,0 +1,96 @@ +--- +title: Sizing +summary: Overview of the sizing modules of aircraftDesign repository +authors: + - Sebastian Oberschwendtner +date: 2023-09-08 +glightbox: false +--- + +## createMissionXML +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## createMissionXML +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## empennageSizing +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## engineSizing +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## fuselageDesign +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## hydrogenTank +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-python: |GPLv3|[Link]()| + +## initialSizing +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## landingGearDesign +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## propulsionIntegration +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## systemsDesign +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| + +## wingDesign +{width=200 align=left} +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. + +|Module Version|Language|License|Documentation| +|:---:|:---:|:---:|---| +|2.1.0|:simple-cplusplus: |GPLv3|[Link]()| \ No newline at end of file