Skip to content
Snippets Groups Projects
Commit 9346a328 authored by alfinjohny1's avatar alfinjohny1
Browse files

Resolve conflicts

parents 8e41448e 70add8c0
No related branches found
No related tags found
1 merge request!9Documentation/gitlab workflow
Pipeline #1555080 waiting for manual action
Showing
with 225 additions and 57 deletions
# Ignore generated Doxygen docs in modules folder
docs/modules/**/
docs/documentation/**/
# Ignore the local docs of the AcXML
docs/aircraft-xml/
......@@ -28,17 +28,29 @@ doxygen:
before_script:
- apk update && apk --no-cache add git doxygen graphviz ttf-freefont texmf-dist texmf-dist-latexextra texlive texlive-dvi
script:
- git clone -b feature-aircraftGeometry2 --recurse-submodules https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/libraries
- cd libraries/aircraftGeometry2/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/modules/" ) | doxygen -
# clone repos
- git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/aircraft-design
- cd aircraft-design
- git clone --recurse-submodules https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/libraries libs/
# create aircraft design documentation
- cd propulsion_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
- cd ../../wing_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
- cd ../../empennage_design/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
- cd ../../ecological_assessment/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
# create libraries documentation
- cd ../../libs/aircraftGeometry2/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
- cd ../../engine/doc/ && ( cat Doxyfile ; echo "OUTPUT_DIRECTORY = $CI_PROJECT_DIR/docs/documentation/" ) | doxygen -
- cd $CI_PROJECT_DIR
artifacts:
paths:
- $CI_PROJECT_DIR/docs/modules
- $CI_PROJECT_DIR/docs/documentation
rules:
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
when: on_success
- if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
when: manual
- if: '$CI_PIPELINE_SOURE == "trigger"'
- if: '$CI_PIPELINE_SOURCE == "trigger"'
when: on_success
# === Build and deploy the website ===
......@@ -51,21 +63,6 @@ pages:
- pip install pipenv
- pipenv install
script:
- mkdir $CI_PROJECT_DIR/docs/aircraft-xml
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title General --level 1 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/general.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title MassesAndLoadings --level 3 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/masses.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Geometry --level 6 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/geometry.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Structure --level 2 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/structure.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Accommodation --level 2 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/accommodation.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Propulsion --level 3 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/propulsion.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Systems --level 2 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/systems.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Aerodynamics --level 2 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/aerodynamics.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title StabilityAndControlCharacteristics --level 2 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/stability.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Performance --level 4 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/performance.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title MonetaryValues --level 4 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/monetary.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title EcologicalValues --level 4 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/ecological.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Requirements --level 3 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/requirements.md
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title DesignSpecification --level 4 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/specification.md
- pipenv run mkdocs build --site-dir $CI_PROJECT_DIR/public
needs:
- doxygen
......@@ -77,5 +74,5 @@ pages:
when: on_success
- if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
when: manual
- if: '$CI_PIPELINE_SOURE == "trigger"'
- if: '$CI_PIPELINE_SOURCE == "trigger"'
when: on_success
......@@ -49,24 +49,3 @@ date: yyyy-mm-dd
# Tools
The documentation page uses some custom tools to enable a seamless continuous documentation:
## document_aircraft_xml.py
> Script
This script is used to document the aircraft exchange file.
It parses the XML file and creates the documentation for each node using its description.
The usage is explained in the output when calling the script with the `--help` option:
```sh
usage: document_aircraft_xml.py [-h] [--title title] [--level level] filename
Converts an aircraft XML file to a markdown file. The output is streamed to stdout and can be piped to a file.
positional arguments:
filename The XML file to convert.
options:
-h, --help show this help message and exit
--title title The title of the output page. This also sets the root node which is used to create the document.
--level level The maximum level nodes to be used as headers.
```
UNICADO is the result of years of dedicated research and innovation in the field of aircraft preliminary design. Originating from a rich history of academic efforts in developing design environments, the software represents a significant evolution in how new aircraft configurations are conceived and how emerging technologies are evaluated in existing designs. While many universities globally have achieved high levels of proficiency with similar tools, their impact has often been constrained to academic circles.
The aerospace industry and large-scale research institutions have traditionally relied on tools and methodologies validated by a limited number of universities. This selective validation has created barriers to wider industry adoption, with universities often lacking the resources and scale to independently develop and qualify new design approaches to meet industry demands.
UNICADO bridges this gap by establishing a collaborative, university-based aircraft design environment that unites the expertise and resources of German universities. By consolidating disciplinary knowledge and fostering synergies, UNICADO shifts the focus of academic research and education from developing standalone tools to engaging in impactful design activities.
Developed in close collaboration with aerospace industry leaders and research institutions, UNICADO ensures its methodologies align with industry standards and are rigorously validated. This partnership enables universities to actively contribute to cutting-edge aircraft design research and positions them as competitive players alongside industry leaders.
At its core, UNICADO is more than a tool — it is a platform for collaboration, innovation, and excellence in aircraft design, driving academic and industry partnerships to new heights.
UNICADO - Think. Design. Change.
\ No newline at end of file
/* Define color variables in :root for easy reference */
:root {
--primary-color: #2C3E50; /* Primary color for headers, hero section, and cards */
--background-color: #34495E; /* Background color for main content areas */
--text-color: #D1D5DB; /* Main text color for readability on dark backgrounds */
--button-bg-color: #ffffff; /* Background color for buttons */
--accent-color: #E74C3C; /* Accent color for links and hover effects */
--secondary-accent: #1ABC9C; /* Secondary accent color for icons */
--link-color: #3498DB; /* Link color for clickable items */
--link-hover-color: #E74C3C; /* Hover color for links */
}
.md-header {
background-color: var(--primary-color);
}
/* Apply primary color to tab backgrounds */
[data-md-color-scheme=slate] .md-tabs {
background-color: var(--primary-color);
}
/* Hero Section Styling */
.hero-section {
background-color: var(--primary-color);
padding: 2em;
border-radius: 10px;
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
max-width: 1060px;
margin: auto;
border: 1px solid rgba(255, 255, 255, 0.1);
}
/* Text styling within the hero section */
.intro-text {
color: var(--text-color);
font-size: 1.1em;
}
/* Download button styling */
.download-button-container {
text-align: center;
margin-top: 20px;
}
.download-button {
display: inline-block;
background-color: var(--button-bg-color); /* Uses button background color */
padding: 10px 20px;
font-size: 1.1em;
font-weight: bold;
border-radius: 5px;
text-decoration: none;
color: var(--primary-color); /* Button text color */
transition: background-color 0.3s ease;
}
/* Grid Container */
.grid-container {
grid-gap: .4rem;
display: grid;
grid-template-columns: repeat(auto-fit,minmax(16rem,1fr));
margin: 1em 0;
grid-template-columns: repeat(auto-fit, minmax(220px, 1fr));
gap: 1.5em;
margin: 2em auto;
max-width: 1100px;
padding: 1em;
}
.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;
background-color: var(--primary-color); /* Uses primary color for card background */
padding: 1.5em;
border-radius: 10px;
text-align: left;
color: var(--text-color); /* Text color for readability */
transition: transform 0.3s, box-shadow 0.3s;
}
.grid-item h3 {
font-size: 1.25em;
margin-bottom: 0.5em;
}
.grid-item:where(:hover, :focus) {
border-color: #0000;
box-shadow: var(--md-shadow-z2);
/* Card styling with hover effects */
.card {
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.15);
border: 1px solid rgba(255, 255, 255, 0.1);
}
.card:hover {
transform: translateY(-5px);
box-shadow: 0 8px 16px rgba(0, 0, 0, 0.25);
}
/* Link styling within cards */
.card a {
color: var(--link-color);
font-weight: bold;
}
.card a:hover {
color: var(--link-hover-color); /* Changes to accent color on hover */
}
/* Accent color for icons or specific elements */
.accent {
color: var(--secondary-accent); /* Teal accent color for specific elements */
}
.overview-item {
min-height: 240px;
min-height: 240px;
}
.overview-img {
width: 200px;
}
\ No newline at end of file
width: 200px;
}
/* Footer Styling */
.custom-footer {
display: flex;
align-items: center;
justify-content: space-between;
background-color: var(--primary-color); /* Background color for the footer */
color: var(--text-color);
padding: 1em 2em; /* Adjust padding for spacing */
font-size: 1em; /* Increase text size for better readability */
border-top: 1px solid rgba(255, 255, 255, 0.2); /* Subtle top border */
}
/* Align text and links */
.footer-content {
display: flex;
align-items: center;
gap: 1em; /* Space between text and impressum link */
}
.footer-content p {
margin: 0; /* Remove extra spacing */
font-size: 1.4em; /* Make text slightly larger */
}
/* Footer link styling */
.footer-link {
color: var(--text-color);
text-decoration: none;
font-weight: bold;
font-size: 1.4em;
border-bottom: 1px solid transparent;
margin-left: 1em; /* Space between copyright and link */
}
.footer-link:hover {
border-bottom: 1px solid var(--accent-color); /* Underline on hover with accent color */
}
/* Footer image styling */
.footer-image-container {
display: flex;
align-items: center;
}
.footer-image {
width: 150px; /* Adjust the width as needed */
height: auto;
margin-left: 1em; /* Space between image and text */
border-radius: 8px; /* Optional: Rounded corners */
}
docs/assets/images/developer/python-debug-binaries.png

131 B

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
width="1080"
height="1080"
viewBox="0 0 1080 1080"
version="1.1"
id="svg1"
xml:space="preserve"
sodipodi:docname="airfoil.svg"
inkscape:version="1.3.2 (091e20e, 2023-11-25, custom)"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg"><sodipodi:namedview
id="namedview1"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:showpageshadow="2"
inkscape:pageopacity="0.0"
inkscape:pagecheckerboard="0"
inkscape:deskcolor="#d1d1d1"
inkscape:zoom="0.93981481"
inkscape:cx="539.46798"
inkscape:cy="540"
inkscape:window-width="2400"
inkscape:window-height="1271"
inkscape:window-x="2391"
inkscape:window-y="-9"
inkscape:window-maximized="1"
inkscape:current-layer="svg1" /><defs
id="defs1" /><path
style="fill:none;stroke:#000000;stroke-width:25;stroke-linecap:butt;stroke-linejoin:miter;stroke-dasharray:none;stroke-opacity:1"
d="M 1049.1429,950.1872 C 731.41522,341.03307 259.88089,177.05321 296.867,191.5271 c 0,0 -64.37885,-18.78533 -109.59606,-18.08867 -45.21722,0.69665 -99.148933,17.5084 -124.492615,58.52216 -43.775502,103.0815 -23.519286,142.83581 67.034485,183.01478 90.55377,40.17897 286.27101,104.0098 411.78325,164.92611 212.49543,103.93765 346.87501,243.02744 507.54684,370.28572 z"
id="path1"
sodipodi:nodetypes="cczczcc" /></svg>
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