https://github.com/NREL/WindSE

https://github.com/NREL/WindSE

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/NREL/WindSE
• Owner: NREL
• License: other
• Created: 2019-04-26T21:00:20.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-05T19:37:19.000Z (5 months ago)
• Last Synced: 2024-06-11T17:45:22.925Z (5 months ago)
• Language: Python
• Size: 36.4 MB
• Stars: 48
• Watchers: 13
• Forks: 25
• Open Issues: 23
• Metadata Files:
  • Readme: README.rst
  • Changelog: ChangeLog.rst
  • License: License.txt

Awesome Lists containing this project

• open-sustainable-technology - WindSE - A Python package that uses a FEniCS backend to perform wind farm simulations and optimization. (Renewable Energy / Wind Energy)

README

        
WindSE: Wind Systems Engineering

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Simple Description:

===================

WindSE is a python package that uses a FEniCS backend to perform wind farm simulations and optimization. Documentation can be found at: https://windse.readthedocs.io/en/latest/ 

Quick Start-Up Guide:

=====================

It is easiest to run WindSE within a conda environment. To install conda check this link: `Conda Installation `_. Additionally, WindSE has been tested on MacOS (Catalina 10.15) and Linux (CentOS 7). Windows is not recommended. 

Quick Installation Instructions:

--------------------------------

The easiest way to install windse is to run::

    sh install.sh 

Then the enviroment can be activated using::

    conda activate 

Quick Demo Instructions:

------------------------

Activate the conda environment using::

    conda activate 

Then to run a simple demo, navigate to /demos/documented/Yaml_Examples/ and run::

    windse run 0-wind_farm_2D.yaml

The output of this simulation will be located in the output/2_5D_Wind_Farm/ folder. Use `Paraview `_ to visualize the results in the solutions/ folder. To learn what parameter can be set in the yaml file, head to the `Parameter Documentation `_.