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

Initial commit of website structure.

parents
No related branches found
No related tags found
2 merge requests!76Draft: Updated Python code example,!73Initial open source version
Pipeline #1065449 canceled
*.png filter=lfs diff=lfs merge=lfs -text
*.PNG filter=lfs diff=lfs merge=lfs -text
*.jpg filter=lfs diff=lfs merge=lfs -text
*.JPG filter=lfs diff=lfs merge=lfs -text
# Setup the pipeline for deploying the project homepage
# Copyright (c) UNICADO 2023
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# === Configure pipeline ===
image: python:latest
pages:
stage: deploy
script:
- pip install mkdocs-material
- mkdocs build --site-dir public
artifacts:
paths:
- public
rules:
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
README 0 → 100644
# Unicado Pages
This repository contains the static website of UNICADO which is hosted by GitLab *pages*.
We are using `mkdocs` as the static site generator to generate the website from *markdown* files.
## Preview
> It is assumed you have a working :snake: **Python** installation in the following!
You can preview the website after cloning it. First you need to install `mkdocs` and the used theme by:
```sh
pip install mkdocs mkdocs-material
```
Then you can change the directory to the repository and run
```sh
mkdocs serve
```
This will start a local webserver which you can access with your webbrowser and preview the website.
## Further Documentation
For features of the site generator and its theme please refer to their excellent documentation:
- [&rdca; MkDocs](https://www.mkdocs.org/user-guide/)
- [&rdca; MkDocs Material](https://squidfunk.github.io/mkdocs-material/)
\ No newline at end of file
docs/assets/favicon.png

129 B

docs/assets/images/icon.png

130 B

docs/assets/images/logo.png

130 B

docs/assets/images/unicado_module_chain_v3.jpg

131 B

## General Description
The general overview of the UNICADO process chain is shown below.
![Overview UNICADO Process](assets/images/unicado_module_chain_v3.jpg)
## Module Descriptions
UNICADO comprises a variety of different program modules grouped into
**set up steps**, **sizing loop**, and **post processing steps**. All of
the modules of the predecessor MICADO are controlled by the *convergenceLoop* program,
whereas the workflow of UNICADO is programmed in **RCE** (remote control
environment by DLR).
### Setup Steps
- [Inital Sizing]()
- [Fuselage Design]()
### 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
# Welcome to UNICADO
![banner](assets/images/logo.png)
> The UNICADO software runs predominantly on Windows 10 and upwards. For the installation the following requirements have to be fulfilled:
---
## Installation Requirements
*Required hardware:*
- 8GB RAM
- Intel Core i5 or higher
- 600MB (1.8GB in stand alone) hard disk space
*Required software:*
- Windows / Linux
- [:simple-python: Python :octicons-link-external-16:](https://www.python.org/) 3.11 or later
- [:simple-git: Git :octicons-link-external-16:](https://git-scm.com/downloads) *(must be accessible from a terminal, i.e. added to your PATH variable if not)*
- [:fontawesome-brands-java: Java Runtime Environment :octicons-link-external-16:](https://jdk.java.net/) *(download zip file, unzip to e.g. `C:\Programs`, add `bin` folder of JDK to your **PATH** variable)*
- [RCE :octicons-link-external-16:](https://rcenvironment.de/) *integration platform (download zip file, unzip to e.g. `C:\Programs`)*
!!! note
Please check the [RCE Updates Website :octicons-link-external-16:](https://rcenvironment.de/pages/updatessecurity.html) for which Java version is working with the respective RCE version. Currently, e.g. Java **11.x** is recommended for the current released
*Optional software:*
- [TiGL :octicons-link-external-16:](https://dlr-sc.github.io/tigl/) 3.x for visualizing the aircraft geometry
- [MikTex :octicons-link-external-16:](https://miktex.org/) for creating pdf reports
---
## Standalone Installation Instructions
- First make sure **RCE** is working by launching it once.
- Download and install the workflow with the current [Installer]().
- The installation with the default settings should be fine.
---
## Installation: Troubleshooting
Your installation aborts and the window closes suddenly
- Create the `C:\Programs` folder by yourself.
- If your installation aborts a good first guess is always to restart your pc (Because temp folders might be cleaned after a restart)
- If the restart does not help, close your installation window (if still opened) go to `C:\Users\<YourUserName>\AppData\Local\Temp` and delete all folders beginning with *_M*. Afterwards execute the installer again.
---
## Developer Installation Instructions
There is no dedicated installer for developers. As a developer you are expected to build your own installer. :wink:
The necessary steps to get you up and running are:
- Ensure you have [repository_access]()
- Make sure your build system is working as explained in the [software_development_setup]().
- Then follow the [build_instructions]() to build the software and create your own installer.
# Site configuration for the UNICADO homepage
# Copyright (c) UNICADO 2023
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
# === General site meta data ===
site_name: UNICADO
# === Site configuration ===
markdown_extensions:
- attr_list
- admonition
- pymdownx.details
- pymdownx.superfences
- toc:
permalink: "#"
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
# === Theme configuration ===
theme:
name: material
favicon: assets/favicon.png
logo: assets/images/icon.png
palette:
scheme: slate
primary: blue grey
accent: lime
features:
- navigation.top
- toc.follow
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment