diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5308c4ef57fefcb038b70a196dc9aa29697dba1b..0cf6ba1a2ff5d16766527592d4bbcc6d0c1e8c66 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -21,7 +21,7 @@ pages: tags: - documentation script: - - pip install mkdocs-material + - pip install mkdocs-material mkdocs-glightbox - mkdocs build --site-dir public artifacts: paths: diff --git a/docs/assets/css/unicado.css b/docs/assets/css/unicado.css new file mode 100644 index 0000000000000000000000000000000000000000..d7d9cc939816c800ab95dd09166056a20f99e0d5 --- /dev/null +++ b/docs/assets/css/unicado.css @@ -0,0 +1,20 @@ +.grid-container { + grid-gap: .4rem; + display: grid; + grid-template-columns: repeat(auto-fit,minmax(16rem,1fr)); + margin: 1em 0; +} + +.grid-item { + border: .05rem solid var(--md-default-fg-color--lightest); + border-radius: .1rem; + display: block; + margin: 0; + padding: .8rem; + transition: border .25s,box-shadow .25s; +} + +.grid-item:where(:hover, :focus) { + border-color: #0000; + box-shadow: var(--md-shadow-z2); +} \ No newline at end of file diff --git a/docs/assets/images/banner.png b/docs/assets/images/banner.png new file mode 100644 index 0000000000000000000000000000000000000000..da0080d30d7f97a608743f08f043f0544f34d79e --- /dev/null +++ b/docs/assets/images/banner.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5ac8b569949a92d73185474a331f292f9a293c73d3df76ba899b1d64e9a2d285 +size 2582463 diff --git a/docs/assets/images/screenshot-rce.png b/docs/assets/images/screenshot-rce.png new file mode 100644 index 0000000000000000000000000000000000000000..5454ae024f17536b18c0254398bc1ce6f84c3c44 --- /dev/null +++ b/docs/assets/images/screenshot-rce.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:234426d60a94f95f98e2180b515b793b59744c13616bbce85105beec24b75be8 +size 172536 diff --git a/docs/description.md b/docs/description.md index 449ee9e11afc5da89e0b9dc77bd36a3d1670c188..e4d9ad0b5cdfdb399b3f441dd45baa98dec24fff 100644 --- a/docs/description.md +++ b/docs/description.md @@ -15,49 +15,9 @@ the modules of the predecessor MICADO are controlled by the *convergenceLoop* pr whereas the workflow of UNICADO is programmed in **RCE** (remote control environment by DLR). -### Setup Steps -- [Inital Sizing]() -- [Fuselage Design]() +!!! note + You can refer to the [Module Overview](modules/overview.md) for a list of all available modules. -### Sizing Loop -- [createMissionXML]() -- [wingDesign]() -- [empennageSizing]() -- [engineSizing]() -- [propulsionIntegration]() -- [calculatePolar]() -- [massEstimation]() -- [landingGearDesign]() -- [systemsDesign]() -- [missionAnalysis]() - -### Post Processing Steps - -- Calculate Performance -- Calculate Costs -- [DOC Estimation]() -- [Calculate Emissions]() -- Report Generator -- Create Aircraft Stepfile -- [CPACS Interface]() -- Design Evaluator - -### Additional Software - -- parameterStudyMgr -- [Test Framework]() - -### Libraries - -- [General on libraries]() -- [aixml]() -- [propulsion System]() -- [Blackbox Tests]() -- unicadoRuntimeLibs - -Other used libs: aerodynamics, aircraftGeometry, aircraftNetwork, -atmosphere, engine, liftingLineInterface, runtimeInfo, spline, sqlite3, -standardFiles, svgPlot, svl, TNT, unitConversion ## Training videos > :construction: *tbd:* Add link diff --git a/docs/developer/build-instructions.md b/docs/developer/build-instructions.md index b2908641facb2d11d3820e3521f14b608b350369..1b32b9779958b4c22d083621b313d4db69bee557 100644 --- a/docs/developer/build-instructions.md +++ b/docs/developer/build-instructions.md @@ -4,5 +4,6 @@ summary: Contains the instruction to get the build process up and running. authors: - Sebastian Oberschwendtner date: 2023-09-06 +glightbox: false --- # Build Instructions \ No newline at end of file diff --git a/docs/developer/setup.md b/docs/developer/setup.md index de84812c311f9a101c75278c5065aa8fa1f587e2..958f7d5f0f7fb51174ed9f13c7f0d891d9b2ec39 100644 --- a/docs/developer/setup.md +++ b/docs/developer/setup.md @@ -4,4 +4,5 @@ summary: How to setup the environment to successfully contribute to UNICADO. authors: - Sebastian Oberschwendtner date: 2023-09-06 +glightbox: false --- diff --git a/docs/getting-started/takeoff.md b/docs/getting-started/takeoff.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..4b8b8b2aa9d8bca166904a9f64bd1ae86b7fa61c 100644 --- a/docs/getting-started/takeoff.md +++ b/docs/getting-started/takeoff.md @@ -0,0 +1,83 @@ +--- +title: Cleared for Take-Off +summary: Instructions how to run the workflow +authors: + - Sebastian Oberschwendtner + - Maurice Zimmnau +date: 2023-09-08 +--- +## UNICADO Workflow + +For the full experience of aircraft design, start RCE and run the workflow +Download and install the workflow with the current [UNICADOinstaller](). + +--- + +## Separate tool execution + +You may want to build and execute UNICADO tools separately. Here we go: + +### Requirements + +Clone the following repositories: + +- **rAIRCRAFTDESIGN** - aircraft design tools +- **rAIRCRAFTREFERENCES** - aircraft reference designs +- **rADDITIONALSOFTWARE** - additional not aircraft design specific tools, e.g. for plotting + +NOTE: the repositories **rAIRCRAFTDESIGN** and **rADDITIONALSOFTWARE** shall be checked out on the same branch (e.g. *develop*), as those branches are synchronized on remote ☁ and a running 🏃 🏃 couple 💍 + +For testing purposes you most probably will choose the CSR-02 aircraft reference. Therefore, checkout the *CSR-02* branch from the **rAIRCRAFTREFERENCES** repo. + +--- + +### Project Environment + +For creating a {nav project environment} you have several options 🍟. Here we'll present the two mostly used ones (Excluding the UNICADOworkflow on RCE stated at top) + +- Create a new folder for your project environment **or** use the folder where you have cloned the **rAIRCRAFTDESIGN** repo +- Copy {nav Gnuplot} and {nav Inkscape} from the folder where you have cloned the **rADDITIONALSOFTWARE** repo into your {nav project environment} +{nav name=project environment > Gnuplot } +{nav name=project environment > Inkscape } +NOTE: If you are using a unix based system make sure to copy the linux variants of *Gnuplot* and *Inkscape* named *Gnuplot-linux* and *Inkscape-linux* + +- Copy the tool(s) you want to execute / test (e.g. *initialSizing*) from your local copy of **rAIRCRAFTDESIGN** (In case you are **not** using the local copy itself as a **project environment**) +{nav name=project environment > initialSizing } +- Create a folder named *projects* within your **project environment** +{nav name=project environment > projects } +- Within your *projects* folder create a folder named as the aircraft class, e.g. {nav CSR} (CeRAS Short Range) +{nav name=project environment > projects > CSR } +- Within the aircraft class folder create a folder of the aircraft type, e.g. {nav CSR-02} +{nav name=project environment > projects > CSR > CSR-02 } +- Copy the **content** (not the folder) of a specific design folder of the corresponding aircraft from your local copy of **rAIRCRAFTREFERENCES** into the aircraft type folder. Options are +{nav cleanSheetDesign} +{nav retrofitDesign > aerodynamicCalibration} +{nav retrofitDesign > engineCalibration} +{nav retrofitDesign > withoutCalibration} +- Now you have again two options: **1.** Test the tool on an empty aircraft exchange file. **2.** Test the tool on a so called converged aircraft. + - For **1.** Delete the existing aircraft exchange fiel e.g. *CSR-02.xml*. Then rename the aircraft exchange file e.g. *CSR-02_startCSD.xml* to *CSR-02.xml* (if you have copied the cleanSheetDesign [CSD]) + - For **2.** Directly execute your tool with the available aircraft exchange file, e.g. *CSR-02.xml* + + +--- + +### Aircraft Design Tool Dependencies + +Suppose you use an empty aircraft exchange file (described above in option **1.**). +The aircraft design tools have dependencies, e.g. a fuselage 🐳 has to exist in order to mount wings 🐦. An aircraft geometry has to be available in order to conduct an aerodynamic analysis. + +Therefore the tools can be executed based on their dependencies in the following sequence: +{nav initialSizing > fuselageDesign > createMissionXml > wingDesign > empennageSizing > engineSizing > propulsionIntegration > landingGearDesign > calculatePolar > massEstimation > systemsDesign > missionAnalysis} + +--- + +### Tool execution + +Finally we want to execute the tool. But what if we have noticed, that there are no executables in the tool folders? 🔥 +Then the executables have first to be build inside the working copy e.g. of the **rAIRCRAFTDESIGN** repo. Please follow the instructions at [[ software_development_setup/ ]] and [[ build_instructions/ ]] + +If this is done already and an executable is present, then you can execute the respective tool from within the tool folder either on windows directly via double click or via a terminal +- In cmd or powershell e.g. `initialSizing.exe` +- In git bash e.g. `./initialSizing.exe` + +If you want to examine the terminal outputs we've got you covered: `.log`-files are written for each tool diff --git a/docs/index.md b/docs/index.md index fe80567a4126a0afd22e840dc4665ac8c6ce5f47..8e16e1dc4865e71465f0a81c7aff149b3cab4c14 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,58 @@ +--- +title: Welcome to UNICADO +summary: Home page of the UNICADO project +authors: + - Sebastian Oberschwendtner +date: 2023-09-08 +glightbox: false +--- + + # Welcome to UNICADO +**UNICADO** is a preliminary aircraft design tools which groups many design modules. +Go through the following stuff to get an idea what **UNICADO** is and how it works: - +<div class="grid-container" markdown="1"> +<div class="grid-item" markdown="1"> + +:material-clock-fast:{ .lg .middle } __Set up in 5 minutes__ + +--- + +Learn how to set it up. + +[:octicons-arrow-right-24: Getting Started](#) + + </div> + <div class="grid-item" markdown="1"> +:fontawesome-brands-markdown:{ .lg .middle } __It's just Markdown__ + +--- + +Focus on your content and generate a responsive and searchable static site + +[:octicons-arrow-right-24: Reference](#) + +</div> +<div class="grid-item" markdown="1"> + +:material-format-font:{ .lg .middle } __Made to measure__ + +--- + +Change the colors, fonts, language, icons, logo and more with a few lines + +[:octicons-arrow-right-24: Customization](#) +</div> + <div class="grid-item" markdown="1"> + +:material-scale-balance:{ .lg .middle } __Open Source, MIT__ + +--- + +Material for MkDocs is licensed under MIT and available on [GitHub] + +[:octicons-arrow-right-24: License](#) + +</div> +</div> \ No newline at end of file diff --git a/docs/module-overview.md b/docs/module-overview.md deleted file mode 100644 index ec2018f5324ce5e18342087552feec0b1a285770..0000000000000000000000000000000000000000 --- a/docs/module-overview.md +++ /dev/null @@ -1,311 +0,0 @@ -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 -{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]()| - ---- - -### Design Analysis -#### 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]()| - ---- - -## Libraries -#### 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](modules/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]()| - ---- - -## Additional Software -### 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]()| - ---- \ No newline at end of file diff --git a/docs/workflow.md b/docs/workflow.md new file mode 100644 index 0000000000000000000000000000000000000000..133ccdb26959245c62aa7db09dfd13492e6f72fb --- /dev/null +++ b/docs/workflow.md @@ -0,0 +1,16 @@ +--- +title: Worfklow +summary: Introduces the UNICADO workflow in RCE +authors: + - Sebastian Oberschwendtner +date: 2023-09-08 +--- + +## RCE + +## Workflow +The workflow looks like this: +<figure markdown> + {width="800"} + <figcaption>UNICADO Workflow</figcaption> +</figure> \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 4cd94fb37b5246bad0cb7faae0fdb7cc6eb97631..cb9d726b99c69b034b3aa1561edc999e337127b8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -30,6 +30,13 @@ markdown_extensions: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg +extra_css: + - assets/css/unicado.css + +# === Plugins === +plugins: + - glightbox + # === Theme configuration === theme: name: material @@ -50,8 +57,15 @@ nav: - 'Home': - 'index.md' - 'description.md' + - 'workflow.md' - 'partners.md' - - 'Module Overview': 'module-overview.md' + - 'Module Overview': + - 'modules/overview.md' + - 'Aircraft Design': + - 'modules/sizing.md' + - 'modules/analysis.md' + - 'modules/libraries.md' + - 'modules/additional-software.md' - 'Getting Started': - 'getting-started/installation.md' - 'getting-started/takeoff.md'