Skip to content

Commit 3e78172

Browse files
authored
Update README with new documentation links and badges
Updated documentation links to point to the dev version and modified the build status badge to reflect the master branch.
1 parent 6c7cb99 commit 3e78172

File tree

1 file changed

+9
-17
lines changed

1 file changed

+9
-17
lines changed

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://byuflowlab.github.io/FLOWFarm.jl/stable)
1+
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://flow.byu.edu/FLOWFarm.jl/stable)
22
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://flow.byu.edu/FLOWFarm.jl/dev)
3-
[![Build Status](https://github.com/byuflowlab/FLOWFarm.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/byuflowlab/FLOWFarm.jl/actions/workflows/CI.yml?query=branch%3Amain)
4-
3+
[![Build Status](https://github.com/byuflowlab/FLOWFarm.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/byuflowlab/FLOWFarm.jl/actions/workflows/CI.yml?query=branch%3Amaster)
54
# FLOWFarm.jl
6-
75
**Summary:** Wind farm simulation tool for gradient-based optimization.
8-
96
**Authors:** Jared J. Thomas, Andrew P.J. Stanley
107

118
## Features
@@ -15,24 +12,19 @@
1512
- Runs on a single core, across multiple cores (threaded), or on multiple machines (distributed).
1613
- Designed so that new model implementations can be included by adding a single method
1714
- Allows for Wake Expansion Continuation (WEC) as described [here](http://flowlab.groups.et.byu.net/preprints/Thomas2021.pdf)
18-
1915
## Installation
2016

2117
### Install FLOWFarm
22-
2318
```
2419
julia
2520
(v1.x) pkg> add FLOWFarm
2621
```
27-
2822
## 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+
*
3629
**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

Comments
 (0)