Skip to content

Commit

Permalink
alert users to Anaconda TOS issues (#295)
Browse files Browse the repository at this point in the history
* alert users to Anaconda TOS issues

* update changelog
  • Loading branch information
RHammond2 committed May 24, 2024
1 parent 47ca939 commit 8c6f81c
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 2 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# 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/).

## Unreleased - TBD

- 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.
Expand Down
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 10 additions & 1 deletion sphinx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8c6f81c

Please sign in to comment.