Merge pull request #53 from NREL/dev

Release 2021.08.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Description
+_Describe the bug here_
+
+### Steps to reproduce issue
+_Please provide a minimum working example (MWE) if possible_
+
+1. …
+2. …
+3. …
+
+### Current behavior
+…
+
+### Expected behavior
+…
+
+
+### Code versions
+_List versions only if relevant_
+- Python
+- …

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+# Description of feature
+Describe the feature here and provide some context. Under what scenario would this be useful?
+
+# Potential solution
+Can you think of ways to implement this?

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,27 @@
+Delete the text explanations below these headers and replace them with information about your PR.
+
+## Purpose
+Explain the goal of this pull request. If it addresses an existing issue be sure to link to it. Describe the big picture of your changes here, perhaps using a bullet list if multiple changes are done to accomplish a single goal. If it accomplishes multiple goals, it may be best to create separate PR's for each. 
+
+## Type of change
+What types of change is it?
+_Select the appropriate type(s) that describe this PR_
+
+- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (non-backwards-compatible fix or feature)
+- [ ] Code style update (formatting, renaming)
+- [ ] Refactoring (no functional changes, no API changes)
+- [ ] Documentation update
+- [ ] Maintenance update
+- [ ] Other (please describe)
+
+## Testing
+Explain the steps needed to test the new code to verify that it does indeed address the issue and produce the expected behavior.
+
+## Checklist
+_Put an `x` in the boxes that apply._
+
+- [ ] I have run existing tests which pass locally with my changes
+- [ ] I have added new tests or examples that prove my fix is effective or that my feature works
+- [ ] I have added necessary documentation

.github/workflows/CI_every_PR.yml

@@ -0,0 +1,65 @@
+name: CI_every_PR
+
+# We run CI on push commits on all branches
+on:
+  pull_request:
+    types: [ready_for_review]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build:
+    name: Build (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: ["ubuntu-latest"] #, "macOS-latest"]
+        python-version: ["3.8"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: conda-incubator/setup-miniconda@v2
+        # https://github.com/marketplace/actions/setup-miniconda
+        with:
+          miniconda-version: "latest"
+          channels: conda-forge
+          auto-update-conda: true
+          python-version: 3.8
+      #     environment-file: environment.yml
+
+      - name: Install test environment
+        shell: pwsh # putting in a shell command makes for compile linking problems later
+        # (if you use the shell here, cannot use 'compiler' package, but mpi only seems to work with it)
+        run: |
+          bash ./install.sh test-environment
+          conda activate test-environment
+        
+      - name: Run all documented demos within WindSE
+        shell: pwsh
+        run: |
+          conda activate test-environment
+          pytest -sv --cov=windse tests/test_demos.py
+
+      - name: Run all regression tests within WindSE
+        shell: pwsh
+        run: |
+          conda activate test-environment
+          pytest -sv --cov=windse --cov-append tests/test_regression.py
+        
+      - name: Run parallel regression tests within WindSE
+        shell: pwsh
+        run: |
+          conda activate test-environment
+          pytest -sv --cov=windse --cov-append tests/test_regression_parallel.py
+      
+      # Run coveralls
+      - name: Run coveralls
+        if: contains( matrix.os, 'ubuntu')
+        # This also works, https://github.com/AndreMiras/coveralls-python-action
+        #uses: AndreMiras/coveralls-python-action@develop
+        shell: pwsh
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          conda activate test-environment
+          coveralls --service=github

.github/workflows/CI_every_commit.yml

@@ -0,0 +1,52 @@
+name: CI_every_commit
+
+# We run CI on push commits on all branches
+on: [push]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build:
+    name: Build (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: ["ubuntu-latest"] #, "macOS-latest"]
+        python-version: ["3.8"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: conda-incubator/setup-miniconda@v2
+        # https://github.com/marketplace/actions/setup-miniconda
+        with:
+          miniconda-version: "latest"
+          channels: conda-forge
+          auto-update-conda: true
+          python-version: 3.8
+      #     environment-file: environment.yml
+
+      - name: Install test environment
+        shell: pwsh # putting in a shell command makes for compile linking problems later
+        # (if you use the shell here, cannot use 'compiler' package, but mpi only seems to work with it)
+        run: |
+          bash ./install.sh test-environment
+          conda activate test-environment
+
+      # Run all tests within WindSE, but not computationally expensive examples
+      - name: Run tests within WindSE
+        shell: pwsh
+        run: |
+          conda activate test-environment
+          pytest -v --cov=windse tests/test_regression.py
+      
+      # Run coveralls
+      - name: Run coveralls
+        if: contains( matrix.os, 'ubuntu')
+        # This also works, https://github.com/AndreMiras/coveralls-python-action
+        #uses: AndreMiras/coveralls-python-action@develop
+        shell: pwsh
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          conda activate test-environment
+          coveralls --service=github

.gitignore

@@ -1,8 +1,30 @@
-*.DS_Store
-*.pyc
-*/output/
-*output/
-*/.ipynb_checkpoints/
-*.ipynb_checkpoints/
-*.egg-info/
-*/.egg-info/
+# Ignore hidden files
+.*
+!/.gitignore
+
+# Ignore notebook files
+*.ipynb
+
+# Ignore result files
+output/
+*.png
+*.eps
+*.pdf
+
+*.xlsx
+# *.yaml
+# *.txt
+# *.csv
+*.zip
+
+*.pvd
+*.vtu
+*.vtk
+*.xdmf
+*.h5
+
+# Ignore Scripts
+*.sh
+
+# Ignore compiled python
+*__pycache__*

ChangeLog.rst

@@ -0,0 +1,67 @@
+ChangeLog:
+==========
+
+2021.8.0:
+---------
+
+Versions:
+~~~~~~~~~
+
+* FEniCS: 2019.1.0, build: py38_9
+* Dolfin-Adjoint: 2019.1.0
+
+New Features:
+~~~~~~~~~~~~~
+
+* Added Regression Tests including Coveralls
+* Switched to Github Actions
+* Added output for angle of attack and rotor plane forces
+* Added Empty and disabled wind farm options
+* Linked OpenMDAO and SNOPT
+* Parallelized Unsteady solver
+* Reorganized Objective functions
+* Added ability to save multiple objectives at once
+* Added blockage based objective functions
+* Grid farm can now be defined using spacing and skew
+* Random farm now respect a minimum distance between turbines
+* Added the option to use a corrective force for momentum loss
+* Added Iterative Steady solvers
+* Added example scripts for small jobs 
+* Added ability to maximize or minimize
+
+
+Bug Fixes
+~~~~~~~~~
+
+* Fixed mpi optimizations
+* Normalized blockage objective functions to report in m/s
+
+
+
+2020.5.0:
+---------
+
+Versions:
+~~~~~~~~~
+
+* FEniCS: 2019.1.0
+* Dolfin-Adjoint: 2019.1.0
+* Requires: tsfc `install reference: <https://fenics.readthedocs.io/projects/ffc/en/latest/installation.html>`_
+
+New Features:
+~~~~~~~~~~~~~
+
+* Added Actuator Line Model
+* Added a Parameter checker
+* Added Unit Tests
+* Added 2.5D options
+* Added Power Functional optimized for 2D
+* Added Numpy Representation for Actuator Disks
+* Driver functions can be used externally
+
+Bug Fixes
+~~~~~~~~~
+
+* Fixed import for Jupyter
+* Fixed boundary label typo
+* Fixed free slip boundary assignment

License.txt

@@ -1,4 +1,4 @@
-Copyright 2019 NREL
+Copyright 2021 NREL
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 

MANIFEST.in

@@ -0,0 +1 @@
+include windse/default_parameters.yaml