Skip to content

Commit

Permalink
Add warnings about dropping support for python 3.8 (#1041)
Browse files Browse the repository at this point in the history
* Add statement about supporting active python versions and warnings regarding dropping 3.8 support

* Try formatting warning differently.

* Simpler formatting for warning.
  • Loading branch information
misi9170 authored Nov 27, 2024
1 parent d961a74 commit 0c07a68
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ the conversation in [GitHub Discussions](https://github.com/NREL/floris/discussi

## Installation

**WARNING:**
Support for python version 3.8 will be dropped in FLORIS v4.3. See [Installation documentation](https://nrel.github.io/floris/installation.html#installation) for details.

**If upgrading from a previous version, it is recommended to install FLORIS v4 into a new virtual environment**.
If you intend to use [pyOptSparse](https://mdolab-pyoptsparse.readthedocs-hosted.com/en/latest/) with FLORIS,
it is recommended to install that package first before installing FLORIS.
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ is highly encouraged. If you are interested in using FLORIS to conduct studies
of a wind farm or extending FLORIS to include your own wake model, please join
the conversation in [GitHub Discussions](https://github.com/NREL/floris/discussions/)!

```{note}
Support for python version 3.8 will be dropped in FLORIS v4.3. See {ref}`installation` for details.
```

## Quick Start

FLORIS is a Python package run on the command line typically by providing
Expand Down
7 changes: 6 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,16 @@ The following sections detail how download and install FLORIS for each use case.
(requirements)=
## Requirements

FLORIS is intended to be used with Python 3.8 and up, and it is highly recommended that users
FLORIS is a python package. FLORIS is intended to work with all [active versions of python](https://devguide.python.org/versions/). Support will drop for python versions once they reach end-of-life.
It is highly recommended that users
work within a virtual environment for both working with and working on FLORIS, to maintain a clean
and sandboxed environment. The simplest way to get started with virtual environments is through
[conda](https://docs.conda.io/en/latest/miniconda.html).

```{warning}
Support for python version 3.8 will be dropped in FLORIS v4.3.
```

Installing into a Python environment that contains a previous version of FLORIS may cause conflicts.
If you intend to use [pyOptSparse](https://mdolab-pyoptsparse.readthedocs-hosted.com/en/latest/)
with FLORIS, it is recommended to install that package first before installing FLORIS.
Expand Down

0 comments on commit 0c07a68

Please sign in to comment.