Skip to content
Snippets Groups Projects
Verified Commit bb40e2b2 authored by Thomas Lambert's avatar Thomas Lambert :helicopter:
Browse files

add: initial structure

parent 0ef0264c
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 334 additions and 0 deletions
contents/intro.tex 0 → 100644
+ 17
− 0
View file @ bb40e2b2
% -----------------------------------------------------------------------------
% General introduction
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% https://gitlab.uliege.be/thlamb/Rotare-doc
%
% License: CC-BY-SA-4.0
% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0
% International License (https://creativecommons.org/licenses/by-sa/4.0/)
% ------------------------------------------------------------------------------
\chapter*{Introduction}
\label{chap:intro}
contents/tech-solvers.tex 0 → 100644
+ 17
− 0
View file @ bb40e2b2
% -----------------------------------------------------------------------------
% Solver technical documentation
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% https://gitlab.uliege.be/thlamb/Rotare-doc
%
% License: CC-BY-SA-4.0
% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0
% International License (https://creativecommons.org/licenses/by-sa/4.0/)
% ------------------------------------------------------------------------------
\chapter{Solvers}
\label{chap:tech:solvers}
contents/tech-validation.tex 0 → 100644
+ 14
− 0
View file @ bb40e2b2
% -----------------------------------------------------------------------------
% Validation cases
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% https://gitlab.uliege.be/thlamb/Rotare-doc
%
% License: CC-BY-SA-4.0
% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0
% International License (https://creativecommons.org/licenses/by-sa/4.0/)
% ------------------------------------------------------------------------------
\chapter{Validation}
\label{chap:tech:valid}
contents/titlepage.tex 0 → 100644
+ 29
− 0
View file @ bb40e2b2
% -----------------------------------------------------------------------------
% Title page for Rotare's documentation.
% Currently only a minimalistic placeholder. A proper titlepage will be made
% later on, once the package trigonthesis is done.
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% https://gitlab.uliege.be/thlamb/Rotare-doc
%
% License: CC-BY-SA-4.0
% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0
% International License (https://creativecommons.org/licenses/by-sa/4.0/)
% ------------------------------------------------------------------------------
\begin{titlepage}
\pdfbookmark[0]{Cover}{Cover}
\flushright
\hfill
\vfill
{\LARGE\docTitle \par}
\rule[5pt]{\textwidth}{.4pt} \par
{\Large\docSubtitle}
\vfill
{\Large\docAuthor}\par
\textit{\large\docDate} \\
Version: \docVersion
\end{titlepage}
contents/user-input.tex 0 → 100644
+ 14
− 0
View file @ bb40e2b2
% -----------------------------------------------------------------------------
% Complete description of Rotare input file
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% <https://gitlab.uliege.be/thlamb/Rotare-doc>
%
% License: CC-BY-SA-4.0
% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0
% International License (<https://creativecommons.org/licenses/by-sa/4.0/>)
% ------------------------------------------------------------------------------
\chapter{Input file}
\label{chap:user:input}
contents/user-install.tex 0 → 100644
+ 14
− 0
View file @ bb40e2b2
% -----------------------------------------------------------------------------
% Installation of Rotare
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% <https://gitlab.uliege.be/thlamb/Rotare-doc>
%
% License: CC-BY-SA-4.0
% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0
% International License (<https://creativecommons.org/licenses/by-sa/4.0/>)
% ------------------------------------------------------------------------------
\chapter{Install guide}
\label{chap:user:install}
contents/user-troubleshooting.tex 0 → 100644
+ 14
− 0
View file @ bb40e2b2
% -----------------------------------------------------------------------------
% Resolution of common issues
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% <https://gitlab.uliege.be/thlamb/Rotare-doc>
%
% License: CC-BY-SA-4.0
% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0
% International License (<https://creativecommons.org/licenses/by-sa/4.0/>)
% ------------------------------------------------------------------------------
\chapter{Troubleshooting}
\label{chap:user:trouble}
contents/user-usage.tex 0 → 100644
+ 14
− 0
View file @ bb40e2b2
% -----------------------------------------------------------------------------
% How to use Rotare
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% <https://gitlab.uliege.be/thlamb/Rotare-doc>
%
% License: CC-BY-SA-4.0
% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0
% International License (<https://creativecommons.org/licenses/by-sa/4.0/>)
% ------------------------------------------------------------------------------
\chapter{Usage}
\label{chap:user:usage}
doc-setup.tex 0 → 100644
+ 84
− 0
View file @ bb40e2b2
% -----------------------------------------------------------------------------
% This file contains the metadata setup and additional packages loaded for the
% documentation of rotare.
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% https://gitlab.uliege.be/thlamb/Rotare-doc
%
% License: CC-BY-SA-4.0
% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0
% International License (https://creativecommons.org/licenses/by-sa/4.0/)
% ------------------------------------------------------------------------------
% ==============================================================================
% DOCUMENT METADATA
% ==============================================================================
% Version number and date.
% ***********************************************
\newcommand{\docDate}{\today}
\newcommand{\docVersion}{v0.0.0}
\newcommand{\docTitle}{Rotare}
\newcommand{\docSubtitle}{Documentation}
\newcommand{\docAuthor}{Thomas Lambert}
\newcommand{\docAffiliation}{\protect{University of Liège}}
% ==============================================================================
% BASE PACKAGE CONFIGURATION
% ==============================================================================
% Encoding and language
% ***********************************************
\PassOptionsToPackage{utf8}{inputenc}
\usepackage{inputenc}
\usepackage[english]{babel}
% Debugging
% ***********************************************
%\listfiles % Used for debugging
% Document style
% ***********************************************
\PassOptionsToPackage{
figuresep=colon,%
hangfigurecaption=false,%
hangsection=true,%
hangsubsection=true,%
sansserif=false,%
configurelistings=true,%
colorize=full,%
colortheme=bluemagenta,%
configurebiblatex=true,%
bibsys=biber,%
bibfile=rotare-bib,%
bibstyle=alphabetic,%
bibsorting=nty,%
}{cleanthesis}
\usepackage{cleanthesis}
% Hyperref setup and pdf metadata
% ***********************************************
\hypersetup{%
pdftitle={\docTitle}, % title (PDF meta)
pdfsubject={\docSubtitle}, % subject (PDF meta)
pdfauthor={\docAuthor}, % author (PDF meta)
plainpages=false, %
colorlinks=false, % colorize links
pdfborder={0 0 0}, % link border
breaklinks=true, % allow line break inside links
bookmarksnumbered=true, %
bookmarksopen=true %
}
% ==============================================================================
% ADDITIONAL PACKAGES
% ==============================================================================
\usepackage{scrhack} % So other packages play nice with KOMA-Scripts
rotare-bib.bib 0 → 100644
+ 14
− 0
View file @ bb40e2b2
@inproceedings{stahlhut2012,
title = {Aerodynamic Design Optimization of Proprotors for Convertible-Rotor Concepts},
booktitle = {American {{Helicopter Society}} 68th {{Annual Forum}}},
author = {Stahlhut, Conor W. and Leishman, J Gordon},
year = {2012},
month = may,
pages = {1--24},
publisher = {{American Helicopter Society}},
address = {{Fort Worth, Texas, USA}},
keywords = {\#nosource,helicopters,IMPORTANT,methods/BEMT,rotors}
}
rotare-doc.tex 0 → 100644
+ 103
− 0
View file @ bb40e2b2
% -----------------------------------------------------------------------------
% This file is the main documentation of Rotare, a feature-rich and open-source
% implementation of the Blade Element Momentum Theory in MATLAB.
%
% Author: Thomas Lambert <t.lambert@uliege.be>
% ULiege - Aeroelasticity and Experimental Aerodynamics
% https://gitlab.uliege.be/thlamb/Rotare-doc
%
% License: CC-BY-SA-4.0
% This work is licensed under a Creative Commons Attribution-ShareAlike 4.0
% International License (https://creativecommons.org/licenses/by-sa/4.0/)
% ------------------------------------------------------------------------------
\documentclass[%
paper=A4, % paper size
twoside=true, % oneside or twoside printing
openright, % chapter headings on right side
parskip=half, % spacing value / method for paragraphs
chapterprefix=true, % prefix for chapter marks
11pt, % font size
headings=normal, % size of headings
bibliography=totoc, % include bib in toc
listof=totoc, % include listof entries in toc
titlepage=on, % own page for each title page
captions=tableabove, % display table captions above the float env
chapterprefix=false, % do not display a prefix for chapters
appendixprefix=false, % do not display a prefix for appendix chapter
draft=false, % toggle if draft version
]{scrreprt}%
% ==============================================================================
% DOCUMENT SETUP
% ==============================================================================
\input{doc-setup}
% ==============================================================================
% DOCUMENT CONTENT
% ==============================================================================
\begin{document}
% Front matter
% ***********************************************
\pagenumbering{roman} % roman page numbing (invisible for empty page style)
\pagestyle{empty} % no header or footers
\input{contents/titlepage} % Titlepage
\cleardoublepage
\currentpdfbookmark{\contentsname}{toc}
\setcounter{tocdepth}{2} % define depth of toc
\tableofcontents % display table of contents
\cleardoublepage
% Body
% ***********************************************
\pagenumbering{arabic} % arabic page numbering
\setcounter{page}{1} % set page counter
\pagestyle{scrheadings} % header and footer style
\input{contents/intro} % Introduction
\part{User manual}
\input{contents/user-install}
\input{contents/user-input}
\input{contents/user-usage}
\input{contents/user-troubleshooting}
%\part{Technical documentation}
%\input{contents/tech-architecture}
%\input{contents/tech-solvers}
%\input{contents/tech-extensions}
%\input{contents/tech-validation}
%\input{contents/tech-roadmap}
% Back matter
% ***********************************************
%
%{%
% \setstretch{1.1}
% \renewcommand{\bibfont}{\normalfont\small}
% \setlength{\biblabelsep}{0pt}
% \setlength{\bibitemsep}{0.5\baselineskip plus 0.5\baselineskip}
% \printbibliography[nottype=online]
% \newrefcontext[labelprefix={@}]
% \printbibliography[heading=subbibliography,title={Webpages},type=online]
%}
%\cleardoublepage
%\appendix\cleardoublepage
%\input{contents/changelog} % INCLUDE: appendix
\newpage
\mbox{}
% ==============================================================================
% END OF DOCUMENT
% ==============================================================================
\end{document}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment