FLOWERS subpackage integration

.coveragerc

@@ -1,5 +1,7 @@
 [run]
-omit = 
+omit =
     ard/utils/test_utils.py
     ard/farm_aero/placeholder.py
-
+    flowers/visualization.py
+    flowers/optimization/optimization_interface.py
+    flowers/optimization/model_interface.py

.github/workflows/python-tests-consolidated.yaml

@@ -46,8 +46,8 @@ jobs:
       run: |
         pip install .[dev]
 
-  test-unit:
-    name: Run unit tests
+  test-ard-unit:
+    name: Run Ard unit tests
     needs: setup-install
     strategy:
       matrix:
@@ -86,9 +86,9 @@ jobs:
       run: |
         pytest --cov=ard --cov-fail-under=80 test/ard/unit
 
-  test-system:
-    name: Run system tests
-    needs: test-unit
+  test-ard-system:
+    name: Run Ard system tests
+    needs: test-ard-unit
     strategy:
       matrix:
         python-version: [3.12] # ["3.10", "3.11", "3.12", "3.13"]
@@ -127,9 +127,90 @@ jobs:
         pytest --cov=ard --cov-fail-under=50 test/ard/system
         # pytest --cov=ard --cov-fail-under=80 test/ard/system
 
+  test-flowers-unit:
+    name: Run FLOWERS unit tests
+    needs: setup-install
+    strategy:
+      matrix:
+        python-version: [3.12] # ["3.10", "3.11", "3.12", "3.13"]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        include:
+        - os: ubuntu-latest
+          path: ~/.cache/pip
+        - os: macos-latest
+          path: ~/Library/Caches/pip
+        - os: windows-latest
+          path: ~\AppData\Local\pip\Cache
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Get cache dependencies
+      id: cache
+      uses: actions/cache@v4
+      with:
+        path: ${{ matrix.path }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+        restore-keys:
+          ${{ runner.os }}-pip-
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+    - name: Install Ard
+      run: |
+        pip install .[dev]
+    - name: Run unit tests with coverage
+      run: |
+        pytest --cov=flowers --cov-fail-under=80 test/flowers/unit
+
+  test-flowers-system:
+    name: Run FLOWERS system tests
+    needs: test-flowers-unit
+    strategy:
+      matrix:
+        python-version: [3.12] # ["3.10", "3.11", "3.12", "3.13"]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+        include:
+        - os: ubuntu-latest
+          path: ~/.cache/pip
+        - os: macos-latest
+          path: ~/Library/Caches/pip
+        - os: windows-latest
+          path: ~\AppData\Local\pip\Cache
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Get cache dependencies
+      id: cache
+      uses: actions/cache@v4
+      with:
+        path: ${{ matrix.path }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+        restore-keys:
+          ${{ runner.os }}-pip-
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+    - name: Install Ard
+      run: |
+        pip install .[dev]
+    - name: Run system tests with coverage
+      run: |
+        pytest --cov=flowers --cov-fail-under=50 test/flowers/system
+        # pytest --cov=flowers --cov-fail-under=80 test/flowers/system
+
   find-examples:
     name: Find all examples
-    needs: [test-unit, test-system]
+    needs: [test-ard-unit, test-ard-system, test-flowers-unit, test-flowers-system]
     runs-on: ubuntu-latest
     steps:
     - name: Checkout code
@@ -142,7 +223,7 @@ jobs:
       id: find_scripts
       run: |
         echo "scripts<<EOF" >> $GITHUB_OUTPUT
-        find examples -mindepth 2 -maxdepth 2 -name "*.py" | jq -R -s -c 'split("\n")[:-1]' >> $GITHUB_OUTPUT
+        find examples -mindepth 3 -maxdepth 3 -name "*.py" | jq -R -s -c 'split("\n")[:-1]' >> $GITHUB_OUTPUT
         echo "EOF" >> $GITHUB_OUTPUT
     outputs:
       scripts: ${{ steps.find_scripts.outputs.scripts }}
@@ -207,7 +288,7 @@ jobs:
 
   find-examples_nb:
     name: Find all example notebooks
-    needs: [test-unit, test-system]
+    needs: [test-ard-unit, test-ard-system, test-flowers-unit, test-flowers-system]
     if: needs.find-examples_nb.outputs.scripts != '[]'  # skip empty
     runs-on: ubuntu-latest
     steps:
@@ -221,10 +302,10 @@ jobs:
       id: find_notebooks
       run: |
         echo "scripts<<EOF"
-        find examples -mindepth 2 -maxdepth 2 -name "*.ipynb" | jq -R -s -c 'split("\n")[:-1]'
+        find examples -mindepth 3 -maxdepth 3 -name "*.ipynb" | jq -R -s -c 'split("\n")[:-1]'
         echo "EOF"
         echo "scripts<<EOF" >> $GITHUB_OUTPUT
-        find examples -mindepth 2 -maxdepth 2 -name "*.ipynb" | jq -R -s -c 'split("\n")[:-1]' >> $GITHUB_OUTPUT
+        find examples -mindepth 3 -maxdepth 3 -name "*.ipynb" | jq -R -s -c 'split("\n")[:-1]' >> $GITHUB_OUTPUT
         echo "EOF" >> $GITHUB_OUTPUT
     outputs:
       scripts: ${{ steps.find_notebooks.outputs.scripts }}

.gitignore

@@ -1,5 +1,5 @@
 
-### ARD DEVELOPMENT IGNORES 
+### ARD DEVELOPMENT IGNORES
 
 .vscode
 case_files

assets/logomaker/inputs/windio.yaml

@@ -3303,7 +3303,7 @@ site:
                 - 511.7766126774107
     energy_resource:
         name: Example energy resource
-        wind_resource: !include ../../../examples/data/windIO-plant_wind-resource_wrg-example.yaml
+        wind_resource: !include ../../../examples/ard/data/windIO-plant_wind-resource_wrg-example.yaml
 wind_farm:
     name: LogoFarm
     layouts:
@@ -3322,7 +3322,7 @@ wind_farm:
                  1250.0,  1250.0,  1250.0,  1250.0,  1250.0,
                  2500.0,  2500.0,  2500.0,  2500.0,  2500.0
             ]
-    turbine: !include ../../../examples/data/windIO-plant_turbine_IEA-3.4MW-130m-RWT.yaml
+    turbine: !include ../../../examples/ard/data/windIO-plant_turbine_IEA-3.4MW-130m-RWT.yaml
     electrical_substations:
         - electrical_substation:
             coordinates:

examples/flowers/_archive/compute_AEP.py

@@ -0,0 +1,23 @@
+import numpy as np
+import pandas as pd
+
+from flowers import FlowersModel
+
+# Create generic layout
+D = 126.0
+layout_x = D * np.array(
+    [0.0, 0.0, 0.0, 7.0, 7.0, 7.0, 14.0, 14.0, 14.0, 21.0, 21.0, 21.0, 28.0, 28.0, 28.0]
+)
+layout_y = D * np.array(
+    [0.0, 7.0, 14.0, 0.0, 7.0, 14.0, 0.0, 7.0, 14.0, 0.0, 7.0, 14.0, 0.0, 7.0, 14.0]
+)
+
+# Load in wind data
+df = pd.read_csv("../data/HKW_wind_rose.csv")
+
+# Setup FLOWERS model
+flowers_model = FlowersModel(df, layout_x, layout_y)
+
+# Calculate the AEP
+aep = flowers_model.calculate_aep()
+print(aep)