Skip to content

Commit

Permalink
Docs update.
Browse files Browse the repository at this point in the history
  • Loading branch information
misi9170 committed Dec 20, 2023
1 parent 54311fe commit d2ed2f4
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 10 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ controllers, including:
WHOC controllers will also call on design tools such as
[FLORIS](https://github.com/NREL/floris).

Documentation for WHOC can be found on
[nrel.github.io](https://nrel.github.io/wind-hybrid-open-controller/intro.html)

## Code development
To contribute to WHOC, please consider forking the main github repository,
with the [main repo](https://github.com/NREL/wind-hybrid-open-controller) as an
Expand Down
20 changes: 10 additions & 10 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@

format: jb-book
root: intro
# parts:
# - caption: Installation
# chapters:
# - file: install_instructions
# - file: install_old
# - file: install_on_kestrel
# - file: install_spack
# - caption: Usage
# chapters:
# - file: examples
parts:
- caption: Installation
chapters:
- file: install_instructions
- caption: Controllers
chapters:
- file: controllers
- caption: Interfaces
chapters:
- file: interfaces
# - file: order_of_op
6 changes: 6 additions & 0 deletions docs/install_instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Installation

```
git clone https://github.com/NREL/wind-hybrid-open-controller
pip install -e wind-hybrid-open-controller
```

0 comments on commit d2ed2f4

Please sign in to comment.