From 0c07a6857245f0e634c8a2bf7cbd7b89a046281e Mon Sep 17 00:00:00 2001 From: misi9170 <39596329+misi9170@users.noreply.github.com> Date: Wed, 27 Nov 2024 12:15:18 -0500 Subject: [PATCH] Add warnings about dropping support for python 3.8 (#1041) * Add statement about supporting active python versions and warnings regarding dropping 3.8 support * Try formatting warning differently. * Simpler formatting for warning. --- README.md | 3 +++ docs/index.md | 4 ++++ docs/installation.md | 7 ++++++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 28954775a..91df13982 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/index.md b/docs/index.md index 202627695..3bd73151d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 diff --git a/docs/installation.md b/docs/installation.md index 4a06260e6..0e1c22f9d 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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.