Merge pull request #74 from ocayon/develop

Jelle & Uri Major Refactoring

.gitignore

@@ -1 +1,194 @@
-__pycache__
+# User defined files and folders
+#data/
+# processed_data/
+# results/
+old_code/
+venv/
+
+# results
+results/*
+!results/rectangular_wing/
+!results/TUDELFT_V3_LEI_KITE/
+results/rectangular_wing/**
+results/TUDELFT_V3_LEI_KITE/**
+
+# data
+data/*
+!data/rectangular_wing/
+!data/TUDELFT_V3_LEI_KITE/
+data/rectangular_wing/**
+data/TUDELFT_V3_LEI_KITE/**
+
+# processed_data
+processed_data/*
+!processed_data/rectangular_wing/
+!processed_data/TUDELFT_V3_LEI_KITE/
+processed_data/rectangular_wing/**
+processed_data/TUDELFT_V3_LEI_KITE/**
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+#Ignore old thesis
+Aerostructural_model_LEI

CITATION.cff

@@ -0,0 +1,34 @@
+cff-version: 0.1.0
+message: "If you are using this software, please cite it as shown below."
+authors:
+  -
+    family-names: "Cayon"
+    given-names: "Oriol"
+    orcid: "https://orcid.org/0000-0002-2065-8673"
+    family-names: "Poland"
+    given-names: "Jelle Agatho Wilhelm"
+    orcid: "https://orcid.org/0000-0003-3164-5648"
+title: "VortexStepMethod"
+keywords:
+  - Airborne Wind Energy
+version: 0.1.0
+# doi: "11.1111/11111"
+# date-released: YYYY-MM-DD
+license: MIT
+url: "https://github.com/ocayon/Vortex-Step-Method"
+preferred-citation:
+  type: article
+  authors:
+    - family-names: "Cayon"
+      given-names: "Oriol"
+    - family-names: "Gaunaa"
+      given-names: "Mac"
+    - family-names: "Schmehl"
+      given-names: "Roland"
+  doi: "10.3390/en16073061"
+  journal: "Energies"
+  title: "Fast Aero-Structural Model of a Leading-Edge Inflatable Kite"
+  issue: 7
+  volume: 16
+  year: 2023
+  article-number: 3061

LICENSE

@@ -1,3 +1,4 @@
+Copyright (c) 2024 Oriol Cayon, Jelle Poland, TU Delft
 Copyright (c) 2022 Oriol Cayon, TU Delft 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

README.md

@@ -1,35 +1,107 @@
-# Vortex_step_method
-Implementation of the Vortex Step Method for a static wing shape
+# Vortex Step Method
+Implementation of the Vortex Step Method for a static wing shape.
 
-# functions_VSM_LLT.py
+## Installation Instructions
+1. Clone the repository:
+    ```bash
+    git clone https://github.com/ocayon/Vortex-Step-Method
+    ```
 
-Contains all the necessary functions to solve the aerodynamics of the wing with both the Vortex Step Method [1,2] and the classic Lifting Line Theory.
+2. Navigate to the repository folder:
+    ```bash
+    cd Vortex-Step-Method
+    ```
+
+3. Create a virtual environment:
+
+   Linux or Mac:
+    ```bash
+    python3 -m venv venv
+    ```
+
+    Windows:
+    ```bash
+    python -m venv venv
+    ```
+
+5. Activate the virtual environment:
 
-# main.py
+   Linux or Mac:
+    ```bash
+    source venv/bin/activate
+    ```
 
-Script to solve for one angle of attack
-INPUTS:
-- Coordinates of the wing (look at the rectangular wing example). 
-The coordinates are defined so that the first point is the LE position of the first section, the second point the TE of the first section and so on. 
-- Convergence criteria
-- Velocity magnitude and direction
-- Number of filaments per horseshoe (default should be 5)
-- Model : 'VSM' or 'LLT'
-- Airfoil polars
+    Windows
+    ```bash
+    .\venv\Scripts\activate
+    ```
 
-# References
+6. Install the required dependencies:
 
-[1] Cayon, O. Fast aeroelastic model of a leading-edge inflatable kite for the design phase of airborne wind energy systems. Master’s
-thesis, Delft University of Technology, 2022. http://resolver.tudelft.nl/uuid:aede2a25-4776-473a-8a75-fb6b17b1a690
+   For users:
+    ```bash
+    pip install .
+    ```
+
+   For developers:
+    ```bash
+    pip install -e .[dev]
+    ```
 
-[2] Maximilian Ranneberg: "Direct Wing Design and Inverse Airfoil Identification with the Nonlinear Weissinger Method". arXiv:1501.04983 [physics.flu-dyn], June 2015. https://arxiv.org/abs/1501.04983
+7. To deactivate the virtual environment:
+    ```bash
+    deactivate
+    ```
+### Dependencies
+- numpy
+- matplotlib>=3.7.1
+- seaborn
+- scipy
+- numba
+- ipykernel
+- screeninfo
 
-[3] Rick Damiani, Fabian F. Wendt, Jason M. Jonkman, Jerome Sicard: "A Vortex Step Method for Nonlinear Airfoil Polar Data as Implemented in KiteAeroDyn". AIAA Scitech 2019 Forum, San Diego, California, 7-11 January 2019. https://doi.org/10.2514/6.2019-0804
+## Usages
+Please look at the tutorial on a rectangular wing, where the code usage and settings are fully detailed.
+You can find it in `examples/rectangular_wing/tutorial_rectangular_wing.ipynb`
 
-## License
+Another tutorial is present under `examples/TUDELFT_V3_LEI_KITE/tutorial_testing_stall_model.py` where a geometry is loaded from .csv, plotted, distributions are plotted and polars are created to demonstrate the effect of the stall model.
+
+For more detailed information one is referred to:
+- [Aerodynamic model](docs/Aerodynamic_model.pdf)
+- [Paper: Fast Aero-Structural Model of a Leading-Edge Inflatable Kite](https://doi.org/10.3390/en16073061) 
+
+## Contributing Guide
+We welcome contributions to this project! Whether you're reporting a bug, suggesting a feature, or writing code, here’s how you can contribute:
+
+1. **Create an issue** on GitHub
+2. **Create a branch** from this issue
+   ```bash
+   git checkout -b issue_number-new-feature
+   ```
+3. --- Implement your new feature---
+4. Verify nothing broke using **pytest**
+```
+  pytest
+```
+5. **Commit your changes** with a descriptive message
+```
+  git commit -m "#<number> <message>"
+```
+6. **Push your changes** to the github repo:
+   git push origin branch-name
+   
+7. **Create a pull-request**, with `base:develop`, to merge this feature branch
+8. Once the pull request has been accepted, **close the issue**
 
+## Citation
+If you use this project in your research, please consider citing it. 
+Citation details can be found in the `CITATION.cff` file included in this repository.
+
+## License
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
 ### Copyright
-
 Copyright (c) 2022 Oriol Cayon
+
+Copyright (c) 2024 Oriol Cayon, Jelle Poland, TU Delft