Skip to content
Snippets Groups Projects
Commit d7d3fede authored by Sebastian Oberschwendtner's avatar Sebastian Oberschwendtner
Browse files

First layout for including doxygen output in site.

parent 4138c15f
No related branches found
No related tags found
3 merge requests!76Draft: Updated Python code example,!73Initial open source version,!1Doxygen setup for contionuous documentation
# Ignore generated Doxygen docs in modules folder
/docs/modules/
## General Description
The general overview of the UNICADO process chain is shown below.
![Overview UNICADO Process](assets/images/unicado_module_chain_v3.jpg)
<figure markdown>
![Overview UNICADO Process](assets/images/unicado_module_chain_v3.jpg){width="500"}
<figcaption>Overview UNICADO Process</figcaption>
</figure>
## Module Descriptions
......
---
title: Build Instructions
summary: Contains the instruction to get the build process up and running.
authors:
- Sebastian Oberschwendtner
date: 2023-09-06
---
# Build Instructions
\ No newline at end of file
---
title: Software Development Setup
summary: How to setup the environment to successfully contribute to UNICADO.
authors:
- Sebastian Oberschwendtner
date: 2023-09-06
---
File moved
UNICADO collects the following software modules.
The modules are grouped into:
- [ Aircraft Design ](#aircraft-design)
- [ Libraries ](#libraries)
- [Additional Software](#additional-software)
## Aircraft Design
---
### Component Sizing
#### createMissionXML
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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]()|
---
### Design Analysis
#### calculateEmissions
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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]()|
---
## Libraries
#### aerodynamics
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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](modules/aircraftGeometry2/index.html)|
### aircraftNetwork
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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]()|
---
## Additional Software
### cpacsInterface
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
![Icon](assets/images/icon.png){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
......@@ -21,6 +21,7 @@ site_name: UNICADO
markdown_extensions:
- attr_list
- admonition
- md_in_html
- pymdownx.details
- pymdownx.superfences
- toc:
......@@ -39,5 +40,25 @@ theme:
primary: blue grey
accent: lime
features:
- navigation.path
- navigation.top
- navigation.tabs
- toc.follow
# === Page Tree ===
nav:
- 'Home':
- 'index.md'
- 'description.md'
- 'partners.md'
- 'Module Overview': 'module-overview.md'
- 'Getting Started':
- 'getting-started/installation.md'
- 'getting-started/takeoff.md'
- 'Developer':
- 'developer/build-instructions.md'
- 'developer/setup.md'
- 'About':
- 'license.md'
- 'contact.md'
- 'impressum.md'
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment