Welcome to FUSED-Wake’s documentation!¶
Contents:
FUSED-Wake¶
A collection of wind farm flow models for FUSED-Wind
- Free software: GNU Affero v3 license
- Documentation: https://fusedwake.readthedocs.org.
Features¶
- TODO
Credits¶
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
Installation¶
At the command line:
$ easy_install fusedwake
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv fusedwake
$ pip install fusedwake
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/DTUWindEnergy/FUSED-Wake/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
FUSED-Wake could always use more documentation, whether as part of the official FUSED-Wake docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/DTUWindEnergy/FUSED-Wake/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up fusedwake for local development.
Fork the fusedwake repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/FUSED-Wake.gitInstall your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv fusedwake $ cd FUSED-Wake/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-featureNow you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 fusedwake tests $ python setup.py test $ tox
To get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/rethore/FUSED-Wake/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Development Lead¶
- Juan Pablo Murcia <jumu@dtu.dk>
- Pierre-Elouan Rethore <pire@dtu.dk>
Contributors¶
- Ewan Machefaux
- Mathieu Gaumond
- Alfredo Pena Diaz
- Rolf-Erik Keck
- Helge Madsen
References¶
| [Keck_2011] | Keck et al., Implementation of a Mixing Length Turbulence Formulation Into the Dynamic Wake Meandering Model, Journal of Solar Energy Engineering, Volume 134, Issue 2, 021012 (13 pages), 2011. |
| [Keck_2012] | Keck et al., Two Improvements to the Dynamic Wake Meandering Model: Including the Effects of Atmospheric Shear on Wake Turbulence and Incorporating Turbulence Build-up in a Row of Wind Turbines, Journal of Wind Energy 2012. |
| [Keck_2013a] | Keck et al., On Atmospheric Stability in the Dynamic Wake Meandering Model,Journal of wind energy January 2013. |
| [Keck_2013b] | Keck et al., A consistent turbulence formulation for the dynamic wake meandering model in the atmospheric boundary layer, PhD thesis, DTU Wind Energy PhD-0012 (EN), July 2013. |
| [Keck_2014] | Keck, et al, A pragmatic approach to wind farm simulations using the dynamic wake meandering model. 2014 Wind Energy, 18, 1671–1682. http://doi.org/10.1002/we |
| [Keck_2015] | Keck, R.-E. Validation of the standalone implementation of the dynamic wake meandering model for power production. (2015) Wind Energy, 18(9), 1579–1591. http://doi.org/10.1002/we.1777 |
| [Larsen_2009] | Larsen, G. C. A simple stationary semi-analytical wake model, (2009) 1713(August), 1–21. |
| [Larsen_2011] | Larsen, T. J. et al, Validation of the Dynamic Wake Meander Model for Loads and Power Production in the Egmond aan Zee Wind Farm, 2011 Wind Energy. 1–19. http://doi.org/10.1002/we |
| [Larsen_2015] | Larsen, G. C., Machefaux, E. et al. Wake meandering under non-neutral atmospheric stability conditions - theory and facts. 2015 Journal of Physics: Conference Series, 625(1), 012036. http://doi.org/10.1088/1742-6596/625/1/012036 |
| [Machefaux] | Machefaux, E. et al, Engineering models for merging wakes in wind farm optimization applications. |
| [Madsen_2009] | Madsen, H. A. et al, Calibration and Validation of the Dynamic Wake Meandering Model for Implementation in an Aeroelastic Code. Journal of Solar Energy Engineering, 132(4), 041014. http://doi.org/10.1115/1.4002555 |