Skip to content
A repository of wind plant flow models connected to FUSED-Wind
Jupyter Notebook Fortran Python Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docker
docs
examples
fusedwake
tests
.editorconfig
.gitignore
.travis.yml
AUTHORS.rst
CONTRIBUTING.rst
Dockerfile
HISTORY.rst
LICENSE
MANIFEST.in
Makefile
README.rst
REFERENCES.rst
docker-compose.yml
requirements_dev.txt
setup.cfg
setup.py
tox.ini
travis_pypi_setup.py

README.rst

FUSED-Wake

https://travis-ci.com/FUSED-Wind/FUSED-Wake.svg?branch=master Documentation Status

FUSED-Wake is a collection of wind farm flow models.

Notice

This package is in development, everything is in alpha mode. Expect dragons.

Features

Currently FUSED-Wake has the following models implemented:

Roadmap

The following models are planned to be added to this library:

Dependencies

This package has the following dependencies * [windIO](https://github.com/rethore/windIO) * numpy & scipy * plotly (optional) * jupyter (optional) * pandas (optional)

Docs

Documentation is available online at https://fused-wake.readthedocs.org

You can build your own docs locally using the command

$ make docs

Contribute

See CONTRIBUTING

Installation

FUSED-Wake contains Fortran extensions that require a correctly configured Fortran compiler.

Windows compiler installation instructions

  • Install Intel Fortran compiler, and activate as follows:

    $ "C:\Program Files (x86)\Intel\Composer XE\bin\ifortvars.bat" intel64

or

  • MinGW (instruction derived from here)

    1. Install numpy

    2. Install mingw-64 to c:\mingw with x86_64, chose posix, seh options

    3. Add MinGW bin folder (C:\mingw\mingw64\bin) to path variable

    4. Verify you can use gcc by typing gcc into Anaconda prompt

    5. Update your distutils configuration file to indicate you are using MinGW:

      [build]
      compiler=mingw32
      
    6. into either one of the following configuration files:

      • c:\Anaconda\Lib\distutils\distutils.cfg
      • <user_folder>\AppData\Local\Continuum\Miniconda3\Lib\distutils\distutils.cfg

Installing dependencies in a conda environment

Avoid conda and pip taking over packages from each other at random moments:

conda install numpy scipy pandas jupyter plotly
conda install -c conda-forge utm --no-deps
pip install sphinx-fortran --no-deps

And the windIO dependency:

git clone https://github.com/rethore/windIO.git
cd windIO
pip install -e ./ --no-deps

Finally, build and install FUSED-Wake:

git clone https://github.com/FUSED-Wind/FUSED-Wake.git
cd FUSED-Wake
pip install -e ./ --no-deps

Installing simply using pip

pip install numpy scipy pandas jupyter plotly utm sphinx-fortran

And the windIO dependency:

git clone https://github.com/rethore/windIO.git
cd windIO
pip install -e ./

Finally, build and install FUSED-Wake:

git clone https://github.com/FUSED-Wind/FUSED-Wake.git
cd FUSED-Wake
pip install -e ./

Tests

Local tests

You can run the tests for your python environment using

$ make tests

All tests

You can run all the tests for all the suported python versions

$ make all-tests

Linting

You can test if there are some flake8 issues

$ make lint

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

You can’t perform that action at this time.