doc: initial commit

.gitignore

+# Files to ignore
+*.DS_Store
+*.m~
+*.mexw64
+*.mexmaci64
+
+# Folders to ignore
+results/
+
+# Ignore all configs by default and only add some to be kept
+src/configs/*
+!src/configs/template.m
+!src/configs/caradonna1981.m
+!src/configs/knight1937.m
+
+# Ignore all from src/airfoil_data except the ones used for the available configs
+src/airfoil_data/*
+!src/airfoil_data/*.md
+!src/airfoil_data/*.py
+!src/airfoil_data/naca0012.dat
+!src/airfoil_data/NACA_0012-Re_2e5-1e7.mat
+!src/airfoil_data/naca0015.dat
+!src/airfoil_data/NACA_0015-Re_2e5-1e7.mat

CHANGELOG.md

+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog][keep_chglog], and this project adheres
+to [Semantic Versioning][sem_ver].
+
+_This changelog will begin AFTER the first official public release of the code._
+
+## [Unreleased]
+
+_Initial commit_: single rotor in hover/axial flows
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+[sem_ver]:<https://semver.org/spec/v2.0.0.html>
+[keep_chglog]: <https://keepachangelog.com/en/1.0.0/>
+[Unreleased]: https://gitlab.uliege.be/thlamb/rotare

CODEOWNERS

+# Each line is a file pattern followed by one or more owners.
+
+# The following owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence, they
+# will be requested for review when someone opens a merge request.
+* @thlamb

LICENSE

+MIT License
+
+Copyright (c) 2022 University of Liege
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

+# Rotare
+
+**Rotare** is a feature-rich and open-source implementation of the Blade Element
+Momentum Theory in MATLAB.
+
+This software can be used for the analysis and the design of all kinds of
+rotors: helicopters main/tail rotors, aircraft propellers, wind/tidal turbines,
+etc.
+
+Rotare was developed primarily for teaching purposes at the [University of
+Liege][uliege-am] (Belgium) by Thomas Lambert during his Ph.D. The code was
+later extended to add different solvers, many extensions to the base methodology
+and to support more complex geometries. It is now a complete analysis tool that
+can be used in a wide range of applications outside of academia.
+
+## Features
+
+A more exhaustive list of features can be found in [the complete
+documentation][rotare-doc].
+
+### Geometry
+
+- [x] Varying airfoil along the blade
+- [x] Custom twist/taper
+- [ ] Coaxial rotors
+
+### Flow
+
+- [x] Steady/Hover
+- [x] Axial flow
+- [ ] Oblique flow (single rotor only)
+
+### Extensions/corrections
+
+- [x] Tip/Hub losses
+- [ ] Compressibility
+- [ ] Tip relief
+- [ ] Spinner effects
+
+### Solvers
+
+Rotare implements 4 different solvers. Each one solves a different form of the
+BEMT equations. Note that some of these solvers use additional hypotheses and
+may not provide valid results in all situations.
+
+## Installation and utilization
+
+### Download and install
+
+To download the latest working version of Rotare, simply run
+
+```bash
+git clone --recursive https://gitlab.uliege.be/thlamb/rotare
+```
+
+Keep it updated using `git pull --recurse-submodules`.
+
+If you do not use `git`, the best way is to download the latest stable version
+of Rotare from the [release page][rotare-releases]. _Note that simply
+downloading the source code will likely not work as Rotare relies on separate
+libraries; so please use the Release page._
+
+## Documentation
+
+Rotare comes with a [very detailed documentation][rotare-doc]. The documentation
+is made of two parts:
+
+1. The user manual
+2. The technical documentation
+
+The _user manual_ focuses on the practical aspects of the software, such as
+requirements, installation, usage, etc. The _technical documentation_ provides a
+full description of the code architecture, details regarding the methodology,
+the solvers implementations, etc.
+
+Every Rotare function comes with an extended help. This help can be printed in
+the command window by executing `help <functionName>`.
+
+## Issues and troubleshooting
+
+If you encounter some issue while using this code, please read carefully the
+error message. The user configuration file is validated with a custom function
+to ensure that the inputs are correct. If the error is due to incorrect user
+input, a meaningful error message is outputted to help you fix your
+configuration.
+
+If the error has nothing to do with your configuration, please check first the
+troubleshooting section of [the documentation][rotare-doc].
+
+If you encounter any other issue with this code, please check [the issue
+tracker][rotare-issues] and fill a new issue report if applicable. You can also
+contact me directly at tlambert@uliege.be.
+
+## Other
+
+This software will be presented at the [AIAA SciTech 2023 forum][aiaa-scitech]
+in National Harbor, MD (USA). A link to the conference proceeding and the slides
+of the presentation will be provided after the talk.
+
+### Acknowledgments
+
+We would like to thank Theo Delvaux for his initial implementation of the
+oblique flight with the `indfact` solver. We would also like to thank Johan Le
+for his work on the implementation of coaxial rotors during his master thesis.
+
+Their excellent contributions facilitated considerably the final implementation
+of these features in Rotare.
+
+## Contributions
+
+Any contribution or feature-request is welcomed. Feel free to use the [issue
+tracker][rotare-issues] if you want to discuss interesting additions to this
+software.
+
+## License
+
+The Rotare Software is provided under the [MIT license](LICENSE).
+
+[uliege-am]: https://www.am.uliege.be/
+[rotare-doc]: https://gitlab.uliege.be/thlamb/rotare-doc/
+[rotare-issues]: https://gitlab.uliege.be/thlamb/rotare/issues
+[rotare-releases]: https://gitlab.uliege.be/thlamb/rotare/releases
+[aiaa-scitech]: https://www.aiaa.org/SciTech