Merge pull request #305 from NREL/develop

v3.1.3 Release
NREL · Jan 31, 2025 · 7ac7935 · 7ac7935
2 parents 47ca939 + af9b079
commit 7ac7935
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 5 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -25,7 +25,7 @@ repos:
     hooks:
         - id: black
           name: black
-          stages: [commit]
+          stages: [pre-commit]
           language_version: python3
 
   - repo: https://github.com/pre-commit/pre-commit-hooks

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,19 @@
 # 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.3 - 2025-01-31
+
+- Pin SciPy to >= 1.7 and <1.14 to avoid an incompatibility error with PyGAM.
+- Updates the Anaconda recommendation to alert users to the fact that Anaconda is no longer
+technically free, and so commercial users should consider Miniforge or Miniconda installations.
+
+## v3.1.2 - 2024-05-24
+
+- Updates the GitHub Actions workflows to use the latest versions of their workflow dependencies.
+- Changes a reference from the old `MonteCarloAEP._hours_in_res` to the new `MonteCarloAEP.resample_hours`.
+- Adds a step to filling in gaps in a time series that checks to see if there were any missing data,
+which helps avoid Pandas warnings.
+
 ## v3.1.1 - 2024-04-05
 
 - Patches `pyproject.toml`'s package data specification to include openoa in the valid packages to install.

diff --git a/README.md b/README.md
@@ -118,7 +118,15 @@ We strongly recommend using the Anaconda Python distribution and creating a new
 for OpenOA. You can download Anaconda through
 [their website.](https://www.anaconda.com/products/individual)
 
-After installing Anaconda, create and activate a new conda environment with the name "openoa-env":
+> [!IMPORTANT]
+> In 2020, Anaconda has changed the Terms of Service for its commercial distribution, and so it is
+> recommended to use either [Miniforge Conda](https://github.com/conda-forge/miniforge), which
+> uses a BSD-3 clause license, or
+> [Miniconda](https://docs.anaconda.com/free/miniconda/index.html), the free tier of Anaconda,
+> depending on your organization's considerations.
+
+After installing Anaconda (or alternative), create and activate a new conda environment with the
+name "openoa-env":
 
 ```bash
 conda create --name openoa-env python=3.10

diff --git a/openoa/__init__.py b/openoa/__init__.py
@@ -1,4 +1,5 @@
-__version__ = "3.1.1"
+__version__ = "3.1.3"
+
 """
 When bumping version, please be sure to also update parameters in sphinx/conf.py
 """

diff --git a/pyproject.toml b/pyproject.toml
@@ -19,7 +19,7 @@ dependencies = [
     "numpy>=1.24",
     "pandas>=2.2",
     "pygam>=0.9.0",
-    "scipy>=1.7",
+    "scipy>=1.7,<1.14",
     "statsmodels>=0.11; python_version<'3.11'",
     "statsmodels>=0.13.3; python_version=='3.11'",
     "tqdm>=4.28.1",

diff --git a/sphinx/index.md b/sphinx/index.md
@@ -69,7 +69,16 @@ We strongly recommend using the Anaconda Python distribution and creating a new
 for OpenOA. You can download Anaconda through
 [their website.](https://www.anaconda.com/products/individual)
 
-After installing Anaconda, create and activate a new conda environment with the name "openoa-env":
+```{important}
+In 2020, Anaconda has changed the Terms of Service for its commercial distribution, and so it is
+recommended to use either [Miniforge Conda](https://github.com/conda-forge/miniforge), which
+uses a BSD-3-Clause license, or
+[Miniconda](https://docs.anaconda.com/free/miniconda/index.html), the free tier of Anaconda,
+depending on your organization's considerations.
+```
+
+After installing Anaconda (or alternative), create and activate a new conda environment with the
+name "openoa-env":
 
 ```bash
 conda create --name openoa-env python=3.10