Skip to content
Snippets Groups Projects
Commit 3dc576bf authored by kbistreck's avatar kbistreck
Browse files

Merge branch 'fix/updateDownload' into 'develop'

Fix/update download

See merge request !69
parents d2c4f584 2fc927fd
No related branches found
No related tags found
2 merge requests!73Initial open source version,!69Fix/update download
Pipeline #1628436 passed
You want to **use** UNICADO to get familiar with the workflow and see first results? Great :fire: Then check out the [Installation Guide](installation.md) and the [Cleared for Take-Off](takeoff.md). It includes the prerequisites, troubleshooting hints and a standalone installer. You want to **use** UNICADO to get familiar with the workflow and see first results? Great :fire: Then check out the [Requirements](requirements.md) for installation and usage. Afterwards, you can download and install UNICADO [here](takeoff.md).
If you're a **developer** interested in contributing to UNICADO, follow the [Developer Installation Guide](../get-involved/developer-installation.md). However, you also need to check out the [Installation Requirements](installation.md) first! If you're a **developer** interested in contributing to UNICADO, follow the [Developer Installation Guide](../get-involved/developer-installation.md). However, you also need to check out the [Requirements](requirements.md) to ensure you'll be able to run your code!
> The UNICADO software runs predominantly on Windows 10 and upwards. For the installation the following requirements have to be fulfilled: ## Installation Requirements {#installation-requirements}
--- For the installation of UNICADO, the following requirements have to be fulfilled:
## Installation Requirements ### Required hardware
*Required hardware:*
- 8GB RAM - 8GB RAM
- Intel Core i5 or higher - Intel Core i5 or higher
- 600MB (16GB in stand alone) hard disk space - 240MB hard disk space + 120MB for installation processes
*Required software:* ### Required software
The UNICADO software runs predominantly on Windows 10 and upwards, so you need to provide such a windows environment.
## Additional Software to Use UNICADO {#additional-software}
To run UNICADO, you will need some external software. It can be downloaded on the corresponding websites.
### Required software
- Windows / Linux
- [:simple-python: Python :octicons-link-external-16:](https://www.python.org/) **3.11** - [:simple-python: Python :octicons-link-external-16:](https://www.python.org/) **3.11**
- [: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)
- [: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`)
- [RCE :octicons-link-external-16:](https://rcenvironment.de/) *integration platform (download zip file, unzip to e.g. `C:\Programs`)* - [gnuplot :octicons-link-external-16:](https://sourceforge.net/projects/gnuplot/) for generating plots with matplot++ (download and add `bin` folder to your **PATH** variables). Gnuplot 6.0.2 is recommended!
- [gnuplot :octicons-link-external-16:](https://sourceforge.net/projects/gnuplot/) for generating plots with matplot++ (download and add `bin` folder to your **PATH** variables)
- [Inkscape :octicons-link-external-16:](https://inkscape.org/release/inkscape-1.4/) for creating plots for pdf reports (download and add `bin` folder to your **PATH** variables)
!!! note !!! 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 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:* ### Optional software
- [TiGL :octicons-link-external-16:](https://dlr-sc.github.io/tigl/) 3.x for visualizing the aircraft geometry - [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 - [MikTex :octicons-link-external-16:](https://miktex.org/) for creating pdf reports
- [Inkscape :octicons-link-external-16:](https://inkscape.org/release/inkscape-1.4/) for creating plots for pdf reports (download and add `bin` folder to your **PATH** variables)
---
## 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.
--- ---
title: Cleared for Take-Off title: Cleared for Take-Off
summary: Instructions how to run the workflow summary: Instructions how to install the workflow
authors: authors:
- Sebastian Oberschwendtner - Sebastian Oberschwendtner
- Maurice Zimmnau - Maurice Zimmnau
- Kristina Mazur - Kristina Mazur
- Katrin Bistreck
date: 2024-11-05 date: 2024-11-05
--- ---
## Installer
When you fullfil all the [requirements](requirements.md), you can download and install the workflow with the current [:material-download: UNICADO installer](). This [standalone workflow tutorial](../tutorials/standalone.md) will show you in a video how this will look like.
When you have followed the installation instructions, you can download and install the workflow with the current [:material-download: UNICADO installer](). This [standalone workflow tutorial](../tutorials/standalone.md) will show you in a video how this will look like. ## 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.
...@@ -48,8 +48,9 @@ Where <new-branch-name> is the branch where developers work on new features or b ...@@ -48,8 +48,9 @@ Where <new-branch-name> is the branch where developers work on new features or b
Make sure your branch name follows this convention: Make sure your branch name follows this convention:
- `feature/your-feature` # Changes which brings in new feature - `feature/your-feature` # Changes which brings in new feature
- `bugfix/your-bugfix` # Changes which fixes bug - `fix/your-fix` # Changes which fixes bug
- `documentation/your_documentation` #Changes which adapt existing documentation / Adding new documentation. - `refactor/your-refactor` # Changes which refactor the code
- `release/your-release`# Your release verion (only relevant for Unicado owner!)
This ensures your branch can be pushed successfully. This ensures your branch can be pushed successfully.
......
...@@ -235,7 +235,7 @@ nav: # Customizes the main navigation struc ...@@ -235,7 +235,7 @@ nav: # Customizes the main navigation struc
- Home: index.md # Main page of the site. - Home: index.md # Main page of the site.
- Download: # Top-level navigation item for "Download". - Download: # Top-level navigation item for "Download".
- Getting Started: download/getting-started.md # Link to the getting started page. - Getting Started: download/getting-started.md # Link to the getting started page.
- Installation: download/installation.md # Link to the installation page. - Requirements: download/requirements.md # Link to the installation requirements page.
- Cleared for Take-Off: download/takeoff.md # Link to the takeoff/getting started page. - Cleared for Take-Off: download/takeoff.md # Link to the takeoff/getting started page.
- Tutorials: - Tutorials:
- Standalone Workflow: tutorials/standalone.md # Link to the standalone tutorial page. - Standalone Workflow: tutorials/standalone.md # Link to the standalone tutorial page.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment