From bb40e2b2571d368caf72cdeb3f4cb219750c3ef4 Mon Sep 17 00:00:00 2001
From: Thomas Lambert <t.lambert@uliege.be>
Date: Thu, 2 Jun 2022 11:56:40 +0200
Subject: [PATCH] add: initial structure
---
contents/intro.tex | 17 +++++
contents/tech-solvers.tex | 17 +++++
contents/tech-validation.tex | 14 ++++
contents/titlepage.tex | 29 +++++++++
contents/user-input.tex | 14 ++++
contents/user-install.tex | 14 ++++
contents/user-troubleshooting.tex | 14 ++++
contents/user-usage.tex | 14 ++++
doc-setup.tex | 84 ++++++++++++++++++++++++
rotare-bib.bib | 14 ++++
rotare-doc.tex | 103 ++++++++++++++++++++++++++++++
11 files changed, 334 insertions(+)
create mode 100644 contents/intro.tex
create mode 100644 contents/tech-solvers.tex
create mode 100644 contents/tech-validation.tex
create mode 100644 contents/titlepage.tex
create mode 100644 contents/user-input.tex
create mode 100644 contents/user-install.tex
create mode 100644 contents/user-troubleshooting.tex
create mode 100644 contents/user-usage.tex
create mode 100644 doc-setup.tex
create mode 100644 rotare-bib.bib
create mode 100644 rotare-doc.tex
diff --git a/contents/intro.tex b/contents/intro.tex
new file mode 100644
index 0000000..df3907e
--- /dev/null
+++ b/contents/intro.tex
@@ -0,0 +1,17 @@
+% -----------------------------------------------------------------------------
+% 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}
+
+
+
diff --git a/contents/tech-solvers.tex b/contents/tech-solvers.tex
new file mode 100644
index 0000000..55f0df6
--- /dev/null
+++ b/contents/tech-solvers.tex
@@ -0,0 +1,17 @@
+% -----------------------------------------------------------------------------
+% 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}
+
+
+
diff --git a/contents/tech-validation.tex b/contents/tech-validation.tex
new file mode 100644
index 0000000..4da0b5d
--- /dev/null
+++ b/contents/tech-validation.tex
@@ -0,0 +1,14 @@
+% -----------------------------------------------------------------------------
+% 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}
diff --git a/contents/titlepage.tex b/contents/titlepage.tex
new file mode 100644
index 0000000..d64d0aa
--- /dev/null
+++ b/contents/titlepage.tex
@@ -0,0 +1,29 @@
+% -----------------------------------------------------------------------------
+% 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}
+
diff --git a/contents/user-input.tex b/contents/user-input.tex
new file mode 100644
index 0000000..0b03896
--- /dev/null
+++ b/contents/user-input.tex
@@ -0,0 +1,14 @@
+% -----------------------------------------------------------------------------
+% 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}
diff --git a/contents/user-install.tex b/contents/user-install.tex
new file mode 100644
index 0000000..56e1ec6
--- /dev/null
+++ b/contents/user-install.tex
@@ -0,0 +1,14 @@
+% -----------------------------------------------------------------------------
+% 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}
diff --git a/contents/user-troubleshooting.tex b/contents/user-troubleshooting.tex
new file mode 100644
index 0000000..5b3fe80
--- /dev/null
+++ b/contents/user-troubleshooting.tex
@@ -0,0 +1,14 @@
+% -----------------------------------------------------------------------------
+% 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}
diff --git a/contents/user-usage.tex b/contents/user-usage.tex
new file mode 100644
index 0000000..4a6eaa6
--- /dev/null
+++ b/contents/user-usage.tex
@@ -0,0 +1,14 @@
+% -----------------------------------------------------------------------------
+% 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}
diff --git a/doc-setup.tex b/doc-setup.tex
new file mode 100644
index 0000000..08fcb60
--- /dev/null
+++ b/doc-setup.tex
@@ -0,0 +1,84 @@
+% -----------------------------------------------------------------------------
+% 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
diff --git a/rotare-bib.bib b/rotare-bib.bib
new file mode 100644
index 0000000..f6dbe1b
--- /dev/null
+++ b/rotare-bib.bib
@@ -0,0 +1,14 @@
+
+@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}
+}
+
+
diff --git a/rotare-doc.tex b/rotare-doc.tex
new file mode 100644
index 0000000..98272c3
--- /dev/null
+++ b/rotare-doc.tex
@@ -0,0 +1,103 @@
+% -----------------------------------------------------------------------------
+% 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}
--
GitLab