Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 8 committers (12.5%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.5%) to scientific vocabulary

Keywords from Contributors

wind openmdao systems-engineering wisdem
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: NREL
  • License: other
  • Language: Python
  • Default Branch: main
  • Size: 37.9 MB
Statistics
  • Stars: 55
  • Watchers: 12
  • Forks: 35
  • Open Issues: 25
  • Releases: 3
Created about 7 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License

README.rst

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 `_.



Owner

  • Name: National Renewable Energy Laboratory
  • Login: NREL
  • Kind: organization
  • Location: Golden, CO

GitHub Events

Total
  • Watch event: 3
  • Push event: 3
  • Pull request event: 6
  • Fork event: 10
Last Year
  • Watch event: 3
  • Push event: 3
  • Pull request event: 6
  • Fork event: 10

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 400
  • Total Committers: 8
  • Avg Commits per committer: 50.0
  • Development Distribution Score (DDS): 0.45
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jeff Allen j****n@n****v 220
Ethan Young e****g@n****v 110
John Jasa j****1@g****m 48
rking r****g@n****v 15
Malik m****y@g****m 3
Pietro Bortolotti p****o@e****v 2
Julian Quick j****k@e****v 1
99kilojoules j****8@h****u 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 32
  • Total pull requests: 89
  • Average time to close issues: 7 months
  • Average time to close pull requests: 18 days
  • Total issue authors: 11
  • Total pull request authors: 10
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.6
  • Merged pull requests: 77
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: 15 days
  • Issue authors: 0
  • Pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • eyoung55 (10)
  • jefalon (6)
  • johnjasa (4)
  • drijazfazil (2)
  • ryannking (2)
  • JonLock1689 (2)
  • kilojoules (2)
  • msjvenegas (1)
  • petebachant (1)
  • Josue9740 (1)
  • misi9170 (1)
  • RafieeAshkan (1)
Pull Request Authors
  • jefalon (48)
  • eyoung55 (19)
  • johnjasa (10)
  • AdrianGushin (4)
  • cfrontin (3)
  • ptrbortolotti (3)
  • kilojoules (3)
  • gbarter (2)
  • JonLock1689 (2)
  • malihass (1)
Top Labels
Issue Labels
enhancement (7) bug (5)
Pull Request Labels
enhancement (2) bug (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
conda-forge.org: windse

Wind Systems Engineering (WindSE) is a simple tool for running RANS based simulation of wind farms. It can be used to optimize layouts, yaws, and axial induction. It is developed and maintainered by NREL.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 33.9%
Dependent repos count: 34.0%
Stargazers count: 38.8%
Average: 39.5%
Dependent packages count: 51.2%
Last synced: 10 months ago

Dependencies

doc/sphinx_requirements.txt pypi
  • openmdao *
  • pyyaml *
.github/workflows/CI_every_PR.yml actions
  • actions/checkout v2 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/CI_every_commit.yml actions
  • actions/checkout v2 composite
  • conda-incubator/setup-miniconda v2 composite
setup.py pypi
environment.yaml pypi
  • fatpack *
  • networkx *
  • pulp *
  • singledispatch *