|
1 | | -[](https://byuflowlab.github.io/FLOWFarm.jl/stable) |
| 1 | +[](https://flow.byu.edu/FLOWFarm.jl/stable) |
2 | 2 | [](https://flow.byu.edu/FLOWFarm.jl/dev) |
3 | | -[](https://github.com/byuflowlab/FLOWFarm.jl/actions/workflows/CI.yml?query=branch%3Amain) |
4 | | - |
| 3 | +[](https://github.com/byuflowlab/FLOWFarm.jl/actions/workflows/CI.yml?query=branch%3Amaster) |
5 | 4 | # FLOWFarm.jl |
6 | | - |
7 | 5 | **Summary:** Wind farm simulation tool for gradient-based optimization. |
8 | | - |
9 | 6 | **Authors:** Jared J. Thomas, Andrew P.J. Stanley |
10 | 7 |
|
11 | 8 | ## Features |
|
15 | 12 | - Runs on a single core, across multiple cores (threaded), or on multiple machines (distributed). |
16 | 13 | - Designed so that new model implementations can be included by adding a single method |
17 | 14 | - Allows for Wake Expansion Continuation (WEC) as described [here](http://flowlab.groups.et.byu.net/preprints/Thomas2021.pdf) |
18 | | - |
19 | 15 | ## Installation |
20 | 16 |
|
21 | 17 | ### Install FLOWFarm |
22 | | - |
23 | 18 | ``` |
24 | 19 | julia |
25 | 20 | (v1.x) pkg> add FLOWFarm |
26 | 21 | ``` |
27 | | - |
28 | 22 | ## Documentation |
29 | | - |
30 | | -* Begin with the [quick start tutorial](https://flow.byu.edu/FLOWFarm.jl/Tutorial/). |
31 | | -* An explanation of how to utilize sparsity can be found in [wind farm struct](https://flow.byu.edu/FLOWFarm.jl/Wind_Farm_Struct/). |
32 | | -* More advanced topics are covered in the [how-to guide](https://flow.byu.edu/FLOWFarm.jl/How_to/). |
33 | | -* Theory details, and links, can be found in the [theory](https://flow.byu.edu/FLOWFarm.jl/Explanation) page. |
34 | | -* Doc strings can be found in the [references](https://flow.byu.edu/FLOWFarm.jl/Reference/) page. |
35 | | - |
| 23 | +* Begin with the [quick start tutorial](https://flow.byu.edu/FLOWFarm.jl/dev/Tutorial/). |
| 24 | +* An explanation of how to utilize sparsity can be found in [wind farm struct](https://flow.byu.edu/FLOWFarm.jl/dev/Wind_Farm_Struct/). |
| 25 | +* More advanced topics are covered in the [how-to guide](https://flow.byu.edu/FLOWFarm.jl/dev/How_to/). |
| 26 | +* Theory details, and links, can be found in the [theory](https://flow.byu.edu/FLOWFarm.jl/dev/Explanation) page. |
| 27 | +* Doc strings can be found in the [references](https://flow.byu.edu/FLOWFarm.jl/dev/Reference/) page. |
| 28 | +* |
36 | 29 | **Citing:** |
37 | | -Thomas, McOmber, and Ning "Wake Expansion Continuation: Multi-Modality Reduction in the Wind Farm Layout Optimization Problem" *Wind Energy* (in review), --> |
38 | | - |
| 30 | +Thomas, McOmber, and Ning "Wake Expansion Continuation: Multi-Modality Reduction in the Wind Farm Layout Optimization Problem" *Wind Energy* (in review), |
0 commit comments