Installation¶
Requirements¶
The supported Python versions are:
Python 3.8
Python 3.9
Python 3.10
Python 3.11
Python 3.12
Python 3.13
TLDR; Quick installation guide¶
Either install via pip:
pip install foxes
Alternatively, install via conda:
conda install foxes -c conda-forge
More details, including guidelines for developers and quicker conda installations, can be found below.
Installation via pip¶
Virtual Python environment¶
First create a new venv
environment, for example called foxes
and located at ~/venv/foxes
(choose any other convenient name and location in your file system if you prefer), by
python3 -m venv ~/venv/foxes
Then activate the environment every time you work with foxes
, by
source ~/venv/foxes/bin/activate
You can leave the environment by
deactivate
The pip
installation commands below should be executed within the active foxes
environment.
Standard users¶
As a standard user, you can install the latest release via pip by
pip install foxes
This commands installs the version that correspond to the main
branch at github. Alternatively, you can decide to install the latest pre-release developments (non-stable) by
pip install git+https://github.com/FraunhoferIWES/foxes@dev#egg=foxes
If you are planning to run wind farm optimizations, please install the foxes-opt package:
pip install foxes[opt]
or
pip install foxes-opt
Developers¶
For developers using pip
, simply invoke the -e
flag in the installation command in your local clone:
git clone https://github.com/FraunhoferIWES/foxes.git
cd foxes
pip install -e .
The last line makes sure that all your code changes are included whenever importing foxes
. Concerning the git clone
line, we actually recommend that you fork foxes
on GitHub and then replace that command by cloning your fork instead.
If you are planning to run wind farm optimizations, please also install the foxes-opt package as described above.
Optional dependencies¶
The following optional dependencies are available:
Option |
Usage |
---|---|
eng |
Installs all engine dependencies |
eng0 |
Like |
dask |
Installs dependencies for |
opt |
Installs foxes-opt |
test |
Dependencies for running the tests |
doc |
Dependencies for creating the docs |
dev |
Usefull tools for code development |
As an example, the optional dependencies eng0
are installed by
pip install foxes[eng0]
or, for development mode, from the foxes
root directory by
pip install -e .[eng0]
Note that options can also be combined, e.g.
pip install foxes[test,dev,eng0]
Installation via conda¶
Preparation (optional)¶
It is recommend to use the libmamba
dependency solver instead of the default solver. Install it once by
conda install conda-libmamba-solver -n base -c conda-forge
We recommend that you set this to be your default solver, by
conda config --set solver libmamba
Virtual Python environment¶
First create a new conda
environment, for example called foxes
, by
conda create -n foxes -c conda-forge
Then activate the environment every time you work with foxes
, by
conda activate foxes
You can leave the environment by
conda deactivate
The conda
installation commands below should be executed within the active foxes
environment.
Standard users¶
The foxes
package is available on the channel conda-forge. You can install the latest version by
conda install foxes -c conda-forge --solver=libmamba
If you are planning to run wind farm optimizations, please install the foxes-opt package instead:
conda install foxes-opt -c conda-forge --solver=libmamba
Note that the --solver=libmamba
in both above commands is optional. Note that it is not necessary if you have set the libmamba
solver as your default, see above.
Developers¶
For developers using conda
, we recommend first installing foxes as described above, then removing only the foxes
package while keeping the dependencies, and then adding foxes
again from a git using conda develop
:
conda install foxes conda-build -c conda-forge --solver=libmamba
conda remove foxes --force
git clone https://github.com/FraunhoferIWES/foxes.git
cd foxes
conda develop .
The last line makes sure that all your code changes are included whenever importing foxes
.
Concerning the git clone
line, we actually recommend that you fork foxes
on GitHub and then replace that command by cloning your fork instead.
If you are planning to run wind farm optimizations, please install the foxes-opt package in addition:
conda install foxes-opt -c conda-forge --solver=libmamba
The --solver=libmamba
is optional. Note that it is not necessary if you have set the libmamba
solver as your default, see above.