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

Initial commit

parents
No related branches found
No related tags found
No related merge requests found
[submodule "style/uliege-latex"]
path = style/uliege-latex
url = git@gitlab.uliege.be:thlamb/uliege-latex.git
[submodule "style/trigonthesis"]
path = style/trigonthesis
url = git@gitlab.public:thlamb/trigonthesis.git
# NOTICE
## Licenses
This documentation and all associated elements (such as figures, graphics, etc)
are provided under the [CC-BY-SA-4.0] license.
Parts of this repository (submodules) are provided under other specific
licenses.
### trigonthesis
This documentation uses the **Trigon Thesis** LaTeX Style, which is licensed
under [LPPL] with the following copyright:
> Copyright 2022 Thomas Lambert
### uliege-latex
This document uses the **uliege-latex** collection of packages to further tweak
the style of the documentation. These packages are licensed under [LPPL] with
the following copyright:
> Copyright 2022 Thomas Lambert
[MIT]: licenses/MIT.md
[GPL-3.0]: licenses/GPL-3.0.md
[Apache-2.0]: licenses/Apache-2.0.md
[W3C-20150513]: licenses/W3C-20150513.md
[CC-BY-SA-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
[CC-BY-SA-3.0]: https://creativecommons.org/licenses/by-sa/3.0/
[CC0-1.0]: https://creativecommons.org/publicdomain/zero/1.0/deed.en
[LPPL]: https://www.latex-project.org/lppl/
[overleaf]: https://overleaf.com
## Rotare - Documentation
This repository contains the complete documentation related to
[**Rotare**][rotare-repo], a feature-rich and open-source implementation of the
Blade Element Momentum Theory in MATLAB.
## Documentation
The documentation is separated in two distinct parts.
### User manual
The user manual focuses on the practical aspects of the software. It details the
requirements, the install process, the setup of the configuration file and the
analysis of the results. It also contains a small troubleshooting guide to help
user resolve the most common issues.
### Technical documentation
The technical documentation is a complete description of the code architecture
and the methodology implemented. It also contains a very detailed mathematical
description of the solvers implemented and of the models used to extend and
correct the base methodology. This technical part also comes with the
presentation of many validation cases.
## Other
An abstract was submitted for the presentation of Rotare during the [AIAA
SciTech 2023 forum][aiaa-scitech] at National Harbor, MD (USA). It is currently
in review by the conference committee.
## License
The present documentation is provided under the [CC-BY-SA-4.0] license. Please
refer to the [Notice](Notice) for the licensing information of the different
packages present in this repository.
The Rotare Software is provided under the [Apache-2.0] license.
[aiaa-scitech]: https://www.aiaa.org/SciTech
[rotare-repo]: https://gitlab.uliege.be/thlamb/rotare
[Apache-2.0]: licenses/Apache-2.0.md
[CC-BY-SA-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
# LaTeXmk compiler configuration file
# https://mirror.koddos.net/CTAN/support/latexmk/latexmk.pdf
# Set master documents
@default_files = ('rotare-doc.tex');
# Set paths for packages, figures and bibliography
ensure_path('TEXINPUTS', './style//','./figures//');
# Set path for bibliography style
ensure_path('BSTINPUTS', './style/');
# Set compiler option (same option for all compilers)
set_tex_cmds('-synctex=1 -interaction=nonstopmode -file-line-error %O %S');
$pdf_mode = 4; # 1: use pdflatex, 4: use lualatex, 5 use xelatex
# Delete bbl files without checking if bib is available (dangerous when bib files are not available)
$bibtex_use = 2;
trigonthesis @ e975dcbc
Subproject commit e975dcbc8656327c505eeda758dd6bf4618cf958
Subproject commit d02e1b836ed59900615a7bcd6b1d1349558998ec
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