Merge pull request #284 from NREL/develop

v3.1

.all-contributorsrc

@@ -0,0 +1,187 @@
+{
+  "projectName": "OpenOA",
+  "projectOwner": "NREL",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitConvention": "angular",
+  "contributorsPerLine": 7,
+  "linkToUsage": true,
+  "contributors": [
+    {
+      "login": "RHammond2",
+      "name": "Rob Hammond",
+      "avatar_url": "https://avatars.githubusercontent.com/u/13874373?v=4",
+      "profile": "https://www.linkedin.com/in/rob-hammond-33583756/",
+      "contributions": [
+        "code",
+        "doc",
+        "review",
+        "tutorial",
+        "maintenance",
+        "ideas",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "jordanperr",
+      "name": "Jordan Perr-Sauer",
+      "avatar_url": "https://avatars.githubusercontent.com/u/355615?v=4",
+      "profile": "https://github.com/jordanperr",
+      "contributions": [
+        "doc",
+        "code",
+        "review",
+        "tutorial",
+        "maintenance",
+        "ideas",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "ejsimley",
+      "name": "ejsimley",
+      "avatar_url": "https://avatars.githubusercontent.com/u/40040961?v=4",
+      "profile": "https://github.com/ejsimley",
+      "contributions": [
+        "projectManagement",
+        "code",
+        "data",
+        "doc",
+        "review",
+        "tutorial",
+        "ideas",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "Dynorat",
+      "name": "Jason Fields",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4141650?v=4",
+      "profile": "https://github.com/Dynorat",
+      "contributions": [
+        "projectManagement",
+        "review",
+        "business",
+        "design",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "nbodini",
+      "name": "Nicola Bodini",
+      "avatar_url": "https://avatars.githubusercontent.com/u/55894604?v=4",
+      "profile": "https://github.com/nbodini",
+      "contributions": [
+        "code",
+        "review",
+        "tutorial",
+        "ideas"
+      ]
+    },
+    {
+      "login": "moptis",
+      "name": "moptis",
+      "avatar_url": "https://avatars.githubusercontent.com/u/32751681?v=4",
+      "profile": "https://github.com/moptis",
+      "contributions": [
+        "code",
+        "data",
+        "doc",
+        "review",
+        "tutorial",
+        "ideas"
+      ]
+    },
+    {
+      "login": "joejoeyjoseph",
+      "name": "Joseph Lee",
+      "avatar_url": "https://avatars.githubusercontent.com/u/22756182?v=4",
+      "profile": "https://github.com/joejoeyjoseph",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "charlie9578",
+      "name": "Charlie",
+      "avatar_url": "https://avatars.githubusercontent.com/u/14888896?v=4",
+      "profile": "https://charlie9578.github.io/",
+      "contributions": [
+        "code",
+        "data",
+        "doc",
+        "tutorial",
+        "ideas"
+      ]
+    },
+    {
+      "login": "zheitkamp1",
+      "name": "zheitkamp1",
+      "avatar_url": "https://avatars.githubusercontent.com/u/53791791?v=4",
+      "profile": "https://github.com/zheitkamp1",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "abbey2017",
+      "name": "Abiodun Timothy Olaoye",
+      "avatar_url": "https://avatars.githubusercontent.com/u/26353690?v=4",
+      "profile": "https://github.com/abbey2017",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "kthyng",
+      "name": "Kristen Thyng",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3487237?v=4",
+      "profile": "http://kristenthyng.com/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "rafmudaf",
+      "name": "Rafael M Mudafort",
+      "avatar_url": "https://avatars.githubusercontent.com/u/13797903?v=4",
+      "profile": "http://www.rafmudaf.com/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "sebastianpfaffel",
+      "name": "sebastianpfaffel",
+      "avatar_url": "https://avatars.githubusercontent.com/u/22168894?v=4",
+      "profile": "https://github.com/sebastianpfaffel",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "nateagarwal",
+      "name": "nateagarwal",
+      "avatar_url": "https://avatars.githubusercontent.com/u/51377789?v=4",
+      "profile": "https://github.com/nateagarwal",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "Var-Char",
+      "name": "Var-Char",
+      "avatar_url": "https://avatars.githubusercontent.com/u/16821332?v=4",
+      "profile": "https://github.com/Var-Char",
+      "contributions": [
+        "code"
+      ]
+    }
+  ]
+}

.github/workflows/ci-tests.yml

@@ -2,9 +2,14 @@ name: Run Unit and Regression Tests with Code Coverage
 
 on:
   push:
-    branches: [ main, develop, develop_v3 ]
+    branches: [main, develop]
   pull_request:
-    branches: [ main, develop, develop_v3 ]
+    branches: [main, develop]
+    paths-ignore:  # No need to rerun all the tests if we're only editing documentation and examples
+      - "examples/**.ipynb"
+      - "sphinx/**"
+      - "**.md"
+      - "**.rst"
   schedule:
     - cron: "0 0 * * MON"
 
@@ -15,7 +20,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: [3.9]
+        python-version: [3.9, 3.11]
 
     steps:
     - uses: actions/checkout@v3

.gitignore

@@ -27,7 +27,7 @@ junit-xml-report.xml
 
 examples/operational_AEP_analysis/data/*.csv
 examples/turbine_analysis/data/*.csv
-examples/cleansed
+examples/data/cleansed
 
 examples/data/kelmarsh/
 examples/data/penmanshiel/

.pre-commit-config.yaml

@@ -14,6 +14,11 @@ repos:
         additional_dependencies: [toml]
         types: [pyi]
 
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+    - id: pyupgrade
+      args: [--py38-plus]
 
   - repo: https://github.com/psf/black
     rev: 23.3.0

CHANGELOG.md

@@ -1,7 +1,49 @@
 # Changelog
 All notable changes to this project will be documented in this file. If you make a notable change to the project, please add a line describing the change to the "unreleased" section. The maintainers will make an effort to keep the [Github Releases](https://github.com/NREL/OpenOA/releases) page up to date with this changelog. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## v3.1 - 2024-03-14
+
+- Updated compatibility with Pandas datetime offsets. All uppercase offset strings representing
+  one hour or less have been replaced with the lowercase version. This stems from an update in the
+  Pandas frequency API that breaks in 2.2.0. See the below changes to update frequency settings. The
+  soon-to-be-deprecated style from Pandas will continue to be supported in OpenOA, but will display
+  a `DeprecationWarning` with support extending until OpenOA v4.
+  - M -> ME (MS still allowed)
+  - H -> h
+  - T -> min
+  - S -> s
+  - L -> ms
+  - U -> us
+  - N -> ns
+- Replaced the "ME" default time basis with "MS" to maintain consistency with the examples.
+- Fixes a bug in the frequency validation where a monthly frequency offset is attempted to be
+  converted into seconds. Prior to Pandas 2.0 this was supported, but "M" would return 1 minute,
+  so OpenOA will no longer attempt to convert "ME" or "MS", which are unsupported or incorrect,
+  respectively.
+- Python 3.11 is now supported.
+- Updates the dependency requirements to minimize the number of required packages, and have a more
+  expansive list of modifiers. Users can now use any combination of
+  `pip install openoa[examples, develop, docs, nrel-wind, reanalysis]` to ensure the appropriate
+  packages are installed for their workflow.
+- Adds a `--unit` and `--regression` flag for running pytest that works in addition to
+`pytest test/unit` or `pytest test/regression`.
+- Converts some configuration files into `pyproject.toml` settings to reduce visual clutter
+  at the top-level of the directory.
+- Updates chained `.loc` expressions to be a single `.loc` expression in project_ENGIE.py to silence
+  a Pandas deprecation warning about future changes.
+- Adds a missing NaN assignment to `project_ENGIE.py:clean_scada`, which causes a slight change in
+  results for the TIE and wake loss regression tests.
+- `openoa.utils.timeseries.gap_fill_data_frame()` now returns the original data if there is no data
+  to fill in, avoiding a Pandas `concat` deprecation warning about pending behavioral changes.
+- The turbine capacity value used for power curve filtering in `TurbineLongTermGrossEnergy` is
+  changed to the rated power from the asset table instead of the maximum power from SCADA. This
+  makes the power curve filtering more robust to turbine power outliers above rated power.
+- Fixed a minor bug in the Cubico example workflow that caused the download of reanalysis data
+  without checking for its existence, unlike what is done with the project data.
+- Updates the README file and documentation site homepage to be more user friendly.
+
 ## [3.0.1 - 2023-12-22]
+
 - Includes warnings about limitations and lack of validation of static yaw misalignment method.
 
 ## v3.0 - 29 September 2023

MANIFEST.in

@@ -1,3 +1,3 @@
 include LICENSE.txt
 
-include readme.md
+include README.md