|
1 | 1 | # OpenOA Documentation
|
2 | 2 |
|
3 |
| -## Installation |
4 |
| - |
5 |
| -Compatible with Python 3.8 through 3.11 with pip. |
6 |
| - |
7 |
| -We strongly recommend using the Anaconda Python distribution and creating a new conda environment |
8 |
| -for OpenOA. You can download Anaconda through |
9 |
| -[their website.](https://www.anaconda.com/products/individual) |
10 |
| - |
11 |
| -After installing Anaconda, create and activate a new conda environment with the name "openoa-env": |
12 |
| - |
13 |
| -```bash |
14 |
| -conda create --name openoa-env python=3.10 |
15 |
| -conda activate openoa-env |
16 |
| -``` |
17 |
| - |
18 |
| -### Source Code |
19 |
| - |
20 |
| -Clone the repository and install the library and its dependencies using pip: |
21 |
| - |
22 |
| -```bash |
23 |
| -git clone https://github.com/NREL/OpenOA.git |
24 |
| -cd OpenOA |
25 |
| -pip install . |
26 |
| -``` |
27 |
| - |
28 |
| -### Pip |
29 |
| - |
30 |
| -```bash |
31 |
| -pip install openoa |
32 |
| -``` |
33 |
| - |
34 | 3 | ## Software Overview
|
35 | 4 |
|
36 | 5 | OpenOA [^1] is a software framework written in Python for assessing wind plant performance using
|
@@ -92,6 +61,37 @@ Some examples of utils modules include:
|
92 | 61 | For further information about the features and citations, please see the
|
93 | 62 | [OpenOA documentation website](https://openoa.readthedocs.io/en/latest/).
|
94 | 63 |
|
| 64 | +## Installation |
| 65 | + |
| 66 | +Compatible with Python 3.8 through 3.11 with pip. |
| 67 | + |
| 68 | +We strongly recommend using the Anaconda Python distribution and creating a new conda environment |
| 69 | +for OpenOA. You can download Anaconda through |
| 70 | +[their website.](https://www.anaconda.com/products/individual) |
| 71 | + |
| 72 | +After installing Anaconda, create and activate a new conda environment with the name "openoa-env": |
| 73 | + |
| 74 | +```bash |
| 75 | +conda create --name openoa-env python=3.10 |
| 76 | +conda activate openoa-env |
| 77 | +``` |
| 78 | + |
| 79 | +### Source Code |
| 80 | + |
| 81 | +Clone the repository and install the library and its dependencies using pip: |
| 82 | + |
| 83 | +```bash |
| 84 | +git clone https://github.com/NREL/OpenOA.git |
| 85 | +cd OpenOA |
| 86 | +pip install . |
| 87 | +``` |
| 88 | + |
| 89 | +### Pip |
| 90 | + |
| 91 | +```bash |
| 92 | +pip install openoa |
| 93 | +``` |
| 94 | + |
95 | 95 | ## Citing OpenOA
|
96 | 96 |
|
97 | 97 | **To cite analysis methods or individual features:** Please cite the original authors of these
|
|
0 commit comments