README.md 2.02 KB
Newer Older
Mads M. Pedersen's avatar
Mads M. Pedersen committed
1 2
[![pipeline status](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake/badges/master/pipeline.svg)](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake/commits/master)
[![coverage report](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake/badges/master/coverage.svg)](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake/commits/master)
Mads M. Pedersen's avatar
Mads M. Pedersen committed
3
[![DOI](https://zenodo.org/badge/164115313.svg)](https://zenodo.org/badge/latestdoi/164115313)
Mads M. Pedersen's avatar
Mads M. Pedersen committed
4 5
[![PyPi](https://img.shields.io/pypi/v/py_wake)](https://pypi.org/project/py-wake/)
[![License](https://img.shields.io/pypi/l/py_wake)](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake/blob/master/LICENSE)
Mads M. Pedersen's avatar
Mads M. Pedersen committed
6

Mads M. Pedersen's avatar
Mads M. Pedersen committed
7 8 9 10

PyWakePark: [![pipeline status](https://gitlab.windenergy.dtu.dk/TOPFARM/cuttingedge/pywake/pywake_park/badges/master/pipeline.svg)](https://gitlab.windenergy.dtu.dk/TOPFARM/cuttingedge/pywake/pywake_park/-/commits/master) PyWakeEllipSys: [![pipeline status](https://gitlab.windenergy.dtu.dk/TOPFARM/cuttingedge/pywake/pywake_ellipsys/badges/master/pipeline.svg)](https://gitlab.windenergy.dtu.dk/TOPFARM/cuttingedge/pywake/pywake_ellipsys/commits/master) 


Mads M. Pedersen's avatar
Mads M. Pedersen committed
11
![PyWake](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake/raw/master/docs/logo.svg)
Mads M. Pedersen's avatar
Logo  
Mads M. Pedersen committed
12

Mads M. Pedersen's avatar
Mads M. Pedersen committed
13 14 15
## Welcome to PyWake
- an AEP calculator for wind farms implemented in Python including a collection of wake models

Mads M. Pedersen's avatar
Mads M. Pedersen committed
16

Mads M. Pedersen's avatar
Mads M. Pedersen committed
17 18 19 20 21 22 23 24 25 26 27
This is a work-in-progress attempt to make something like FUSEDWAKE 2.0. Its relation to FUSEDWAKE is, however, not determined yet.
The idea is that it should:

- Reduce duplicated code
- Include wakemap functions
- Be faster
- Be suitable for layout optimization
- Support use of load surrrogate models
- Support complex terrain
- Support gradient based optimization

28

Mads M. Pedersen's avatar
Mads M. Pedersen committed
29
## Quick Start:
30

Mads M. Pedersen's avatar
Mads M. Pedersen committed
31
`pip install py_wake`
32

Mads M. Pedersen's avatar
Mads M. Pedersen committed
33
## Source code repository (and issue tracker):
34

Mads M. Pedersen's avatar
Mads M. Pedersen committed
35
[https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake)
36

Mads M. Pedersen's avatar
Mads M. Pedersen committed
37 38
## License:
[MIT](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake/blob/master/LICENSE)
39

Mads M. Pedersen's avatar
Mads M. Pedersen committed
40
## Documentation, installation, etc:
41

Mads M. Pedersen's avatar
Mads M. Pedersen committed
42
[https://topfarm.pages.windenergy.dtu.dk/PyWake](https://topfarm.pages.windenergy.dtu.dk/PyWake).
Mads M. Pedersen's avatar
Mads M. Pedersen committed
43