Skip to content
Snippets Groups Projects
Commit 10f2c812 authored by Mads M. Pedersen's avatar Mads M. Pedersen
Browse files

more docs

parent 9596d6d5
No related branches found
No related tags found
No related merge requests found
docs/source/_static/Overview.png

15.9 KiB

File added
......@@ -3,15 +3,30 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to PyWake
===================
.. toctree::
:caption: User Guide
:maxdepth: 2
.. image:: _static/logo.png
:align: center
installation
tutorials
PyWake is an AEP calculator for wind farms implemented in Python including a collection of wake models
Quick Start::
pip install py_wake
Source code repository (and issue tracker):
https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake
License:
MIT_
.. _MIT: https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake/blob/master/LICENSE
Contents:
.. toctree::
:maxdepth: 2
reference_guide
\ No newline at end of file
installation
introduction
reference_guide
Install Python
==============
For all platforms we recommend that you download and install the Anaconda -
a professional grade, full blown scientific Python distribution.
Installing Anaconda, activate root environment:
* Download and install Anaconda (Python 3.x version, 64 bit installer is recommended) from https://www.continuum.io/downloads
* Update the root Anaconda environment (type in a terminal):
``>> conda update --all``
* Activate the Anaconda root environment in a terminal as follows:
``>> activate``
Create envirronment
===================
If you have other Python programs besides PyWake, it is a good idea to install
each program in its own environment to ensure that the dependencies for the
different packages do not conflict with one another. The commands to create and
then activate an environment in an Anaconda prompt are::
conda create --name pywake python=3.6
activate pywake
\ No newline at end of file
.. _installation:
===========================
Installation
===========================
You must first have a working and properly configured Python 3.4+ distribution
on your computer. We often use and highly recommend
`Anaconda <https://www.anaconda.com/download/>`_.
.. toctree::
:maxdepth: 2
Simple user
------------
install_python
If you have other Python programs besides PyWake, it is a good idea to install
each program in its own environment to ensure that the dependencies for the
different packages do not conflict with one another. The commands to create and
then activate an environment in an Anaconda prompt are::
conda create --name pywake python=3.6
activate pywake
Install PyWake (Simple user)
----------------------------
You can install PyWake into the current active environment directly from git::
* Install from PyPi.org (official releases)::
pip install py_wake
pip install git+https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake.git
* Install from gitlab (includes any recent updates)::
pip install git+https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake.git
Developer
----------
Install PyWake (Developer)
--------------------------
We highly recommend developers install PyWake into its own environment. (See
instructions above.) The commands to clone and install PyWake with developer
......
Overview
============
.. image:: _static/Overview.png
AEPCalculator
-------------
The `AEPCalculator` calculates AEP by summarising the product of power,
probability and the number of hours pr year for wind turbines,
wind speeds and wind directions:
.. math::
AEP = \sum_{wt}\sum_{wd}\sum_{ws} P(wd,ws) \cdot Power(wt,wd,ws) \cdot 24 \cdot 365
WindTurbines
------------
The `WindTurbines` provides the power, `Power`, and thrust coefficient, `CT`
for the specified wind turbines, `type`, effective wind speed, `ws_eff` as
well as the wind turbine hubheight(s),`h` and diameter(s), `D`.
WakeModel
---------
The `WakeModel` iterates over all turbines in down-wind order. For the n'th
most upstream turbine, the effective wind speed is calculated by subtracting
the wake deficit from upstream turbines from the local (no-wake) wind speed
(provided by `Site`).
Note, that the way the deficits are summed up is wake-model specific.
The deficit from the current turbine can now be calculated at the position of
all down stream turbines based on the down-stream, cross-wind and vertical
distance (calculated by `Site`), the thrust coefficient (calculated by
`WindTurbines`), etc. Note, that the deficit calculation is also wake-model
specific.
Site
----
`Site` provides the local wind conditions in terms of wind speed, wind
direction and turbulence intensity for a given position (x,y,z) and
reference wind speed and direction. In addition it calculates the
probability, `P`, of this event.
Finally, it calculates the down-wind, cross-wind and vertical distance
between wind turbines which in non-flat terrain is different from the
straight-line distances.
\ No newline at end of file
.. _tutorial:
===========================
Tutorials
===========================
WindTurbines_
.. _WindTurbines: https://colab.research.google.com/github/DTUWindEnergy/PyWake/blob/master/tutorials/windturbines.ipynb
\ No newline at end of file
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