Add dependency and installation instructrions

NREL · Mar 19, 2024 · 78247cf · 78247cf
1 parent 225f20e
commit 78247cf
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 5 deletions.
diff --git a/.github/workflows/deploy-pages.yaml b/.github/workflows/deploy-pages.yaml
@@ -16,12 +16,16 @@ jobs:
 
     # Install dependencies
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
-        python-version: "3.10"
+        python-version: "3.12"
 
     - name: Install dependencies
       run: |
+        git clone https://github.com/rafmudaf/PyWake
+        git clone https://github.com/rafmudaf/foxes
+        pip install -e PyWake
+        pip install -e foxes
         pip install -e ".[docs]"
 
     # Generate any required diagrams

diff --git a/README.md b/README.md
@@ -21,6 +21,33 @@ Documentation for `wcomp` is available at https://rafmudaf.github.io/wcomp/.
 
 **DOI: 10.11578/dc.20231113.4**
 
+# Installation
+
+Currently, `wcomp` must be installed manually `pip`. The dependencies are:
+
+- windIO v1.0, can be installed directly from PyPI
+- FLORIS v3.5, can be installed directly from PyPI but preferably locally from https://github.com/nrel/floris
+- FOXES v0.5.1 plus two additional commits, must be installed from https://github.com/rafmudaf/foxes at main branch
+- PyWake v2.5.0 plus two additional commits, must be installed from https://github.com/rafmudaf/PyWake at master branch
+
+Follow these steps to install the dependencies and `wcomp`:
+1. Create a new Python environment
+2. Install the dependencies:
+
+```bash
+pip install windIO
+git clone https://github.com/nrel/floris && pip install -e floris/
+git clone https://github.com/rafmudaf/foxes && pip install -e foxes/
+git clone https://github.com/rafmudaf/PyWake && pip install -e PyWake/
+```
+
+3. Install `wcomp`:
+
+```bash
+git clone https://github.com/rafmudaf/wcomp
+pip install -e wcomp
+```
+
 ## Architecture and Design
 
 The `wcomp` framework is meant to be simple and flexible. At it's core, it is three

diff --git a/docs/index.md b/docs/index.md
@@ -46,5 +46,31 @@ classDiagram
   pywake_interface --> plotting
 ```
 
+# Installation
+
+Currently, `wcomp` must be installed manually with `pip`. The dependencies are:
+
+- windIO v1.0, can be installed directly from PyPI
+- FLORIS v3.5, can be installed directly from PyPI but preferably locally from https://github.com/nrel/floris
+- FOXES v0.5.1 plus two additional commits, must be installed from https://github.com/rafmudaf/foxes at main branch
+- PyWake v2.5.0 plus two additional commits, must be installed from https://github.com/rafmudaf/PyWake at master branch
+
+Follow these steps to install the dependencies and `wcomp`:
+1. Create a new Python environment
+2. Install the dependencies:
+
+```bash
+pip install windIO
+git clone https://github.com/nrel/floris && pip install -e floris/
+git clone https://github.com/rafmudaf/foxes && pip install -e foxes/
+git clone https://github.com/rafmudaf/PyWake && pip install -e PyWake/
+```
+
+3. Install `wcomp`:
+
+```bash
+pip install wcomp
+```
+
 # Getting started
 Here's how to get started
diff --git a/setup.py b/setup.py
@@ -14,9 +14,9 @@
 
 # What packages are required for this module to be executed?
 REQUIRED = [
-    "floris",
-    "foxes",
-    "py-wake",
+    "floris",   # At develop, latest hash is c7f8f36
+    "foxes",    # At v0.5.1 with two additional commits on rafmudaf/foxes, latest hash is 275f645
+    "py-wake",  # At master with two additional commits on rafmudaf/PyWake, latest hash is 35e63b7
     "numpy>=1.20",
     "windIO",
     "matplotlib",