Release v2.2.0

Merge pull request #357 from OpenFAST/dev
OpenFAST · Nov 13, 2019 · e4faf27 · e4faf27
2 parents f147b80 + 33a4f84
commit e4faf27
Show file tree

Hide file tree

Showing 502 changed files with 243,104 additions and 7,634 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -6,28 +6,24 @@ labels: "Type: Bug"
 ---
 
 **Bug description**
-
-A clear and concise description of the bug.
+<A clear and concise description of the bug.>
 
 **To Reproduce**
-
+<Update the following list with your specific information.>
 Steps to reproduce the behavior:
 1. Compile with '...'
 2. Run '...' case with '...' settings
 3. Open '...' output
 4. See the error
 
 **Expected behavior**
+<A clear and concise description of what you expected to happen.>
 
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-
-If applicable, add screenshots to help explain your problem.
+**Screenshots, if applicable**
+<Add screenshots to help explain your problem.>
 
 **OpenFAST Version**
-
-Please provide as much detail as possible including git commit. The best information is a screenshot of the OpenFAST system description that prints when running OpenFAST:
+<Please provide as much detail as possible including git commit. The best information is a screenshot of the OpenFAST system description that prints when running OpenFAST:>
 
 ```
 **************************************************************************************************
@@ -52,11 +48,9 @@ Please provide as much detail as possible including git commit. The best informa
 ```
 
 **System Information (please complete the following information):**
-
- - OS: [e.g. Ubuntu 14.04 or macOS 10.12]
- - Compiler: [e.g. GFortran 4.4]
- - Compiler settings: [e.g. CMake flags or other settings]
+ - OS: <e.g. Ubuntu 14.04 or macOS 10.12>
+ - Compiler: <e.g. GFortran 4.4>
+ - Compiler settings: <e.g. CMake flags or other settings>
 
 **Additional context**
-
-Add any other context about the problem here.
+<Add any other context about the problem here.>
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -6,17 +6,13 @@ labels: 'Type: Enhancement'
 ---
 
 **Is your feature request related to a problem? Please describe.**
-
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<A clear and concise description of the problem.>
 
 **Describe the solution you'd like**
-
-A clear and concise description of what you want to happen.
+<A clear and concise description of what you want to happen.>
 
 **Describe alternatives you've considered**
-
-A clear and concise description of any alternative solutions or features you've considered.
+<A clear and concise description of any alternative solutions or features youve considered.>
 
 **Additional context**
-
-Add any other context or screenshots about the feature request here.
+<Add any other context or screenshots about the feature request here.>
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,24 +1,18 @@
 
-Complete this sentence
-**THIS PULL REQUEST __ [IS/IS NOT] __ READY TO MERGE**
+**Complete this sentence**
+THIS PULL REQUEST __ [IS/IS NOT] __ READY TO MERGE
 
 **Feature or improvement description**
-
-A clear and concise description of the new code.
+<A clear and concise description of the new code.>
 
 **Related issue, if one exists**
-
-Link to a related GitHub Issue.
+<Link to a related GitHub Issue.>
 
 **Impacted areas of the software**
-
-List any modules or other areas which should be impacted by this pull request. This helps to determine the verification tests.
+<List any modules or other areas which should be impacted by this pull request. This helps to determine the verification tests.>
 
 **Additional supporting information**
+<Add any other context about the problem here.>
 
-Add any other context about the problem here.
-
-**Automated test results**
-
-Add the automated test results (unit tests and regression tests) here, if they've been run.
-For any failing tests, please provide justification.
+**Test results, if applicable**
+<Add the results from unit tests and regression tests here along with justification for any failing test cases.>
diff --git a/.github/actions/compile-and-test/Dockerfile b/.github/actions/compile-and-test/Dockerfile
@@ -0,0 +1,43 @@
+#
+# Copyright 2016 National Renewable Energy Laboratory
+#
+# 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
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+FROM rafmudaf/openfast-ubuntu:dev
+
+# Move into the openfast directory and update
+WORKDIR /openfast
+RUN git fetch
+RUN git pull
+RUN git submodule update
+
+# Move into the "build" directory and compile
+WORKDIR /openfast/build
+RUN cmake ..
+RUN make -j4 install
+
+# Run the tests
+
+# BeamDyn-specific tests
+RUN ctest -VV -j7 -R bd_
+RUN ctest -VV -R beamdyn_utest
+
+# OpenFAST linearization tests
+RUN ctest -VV -j4 -L linear
+
+# Subset of OpenFAST regression tests; do not run
+## - 3, 4, 7, 14, 15, 16, since the free yaw is not well trusted
+## - 9 because its super sensitive
+## - 19, 20 because theyre too long
+RUN ctest -VV -j8 -I 1,1,1,2,5,6,8,10,11,12,13,17,18,21,22,23,24,25
diff --git a/.github/actions/compile-and-test/action.yml b/.github/actions/compile-and-test/action.yml
@@ -0,0 +1,10 @@
+name: 'Compile and test'
+description: 'Compile OpenFAST and run the tests'
+author: 'NREL'
+# inputs:
+#   build-type:
+#     description: 'Set the CMake build type: Release (-O3); RelWithDebInfo (-O2 -g); Debug (-g)'
+#     default: 'Release'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
diff --git a/.github/workflows/continuous-integration-workflow.yml b/.github/workflows/continuous-integration-workflow.yml
@@ -0,0 +1,22 @@
+
+name: OpenFAST Build and Test
+
+on: [push, pull_request]
+
+# runs-on: ${{ matrix.os }}
+# strategy:
+#   matrix:
+#     os: [macOS-10.14, ubuntu-18.04]
+# runs-on: docker://rafmudaf/openfast-ubuntu:alpha
+
+jobs:
+    build-and-test:
+        runs-on: ubuntu-latest
+        name: OpenFAST tests on Ubuntu
+        steps:
+        - name: Checkout
+          uses: actions/checkout@master
+          with:
+            submodule: recursive
+        - name: Build and test step
+          uses: ./.github/actions/compile-and-test
diff --git a/.gitignore b/.gitignore
@@ -32,6 +32,7 @@ __pycache__/*
 
 # Build specific files
 build*/
+_build*/
 install/
 vs-build/
 
@@ -40,3 +41,6 @@ vs-build/
 .vscode
 .atom
 .fortls
+
+# backup files
+*.asv
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,29 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+formats:
+  - htmlzip
+  - pdf
+  # - epub
+
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt
+  system_packages: true
+
+# select the docker image to use: stable | latest
+build:
+  image: stable
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true
diff --git a/.travis.yml b/.travis.yml
@@ -7,62 +7,55 @@
 
 language: c
 
-os:
-    - linux
-    - osx
-
-env:
-    - FC=/usr/local/bin/gfortran-7; DOUBLE_PRECISION=ON
-    - FC=/usr/local/bin/gfortran-7; DOUBLE_PRECISION=OFF
-    - FC=/usr/bin/gfortran; DOUBLE_PRECISION=ON
-    - FC=/usr/bin/gfortran; DOUBLE_PRECISION=OFF
-    - FC=ifort; DOUBLE_PRECISION=ON; TRAVIS_BUILD_INTEL=YES
+matrix:
+  include:
+    - os: linux
+      dist: bionic
+      env: FC=/usr/bin/gfortran-7; DOUBLE_PRECISION=OFF
+    - os: linux
+      dist: bionic
+      env: FC=/usr/bin/gfortran-7; DOUBLE_PRECISION=ON; CPP_API=ON; CMAKE_FLAGS="-DBUILD_OPENFAST_CPP_API=$CPP_API"
+    - os: linux
+      dist: bionic
+      env: FC=/usr/bin/gfortran-7; DOUBLE_PRECISION=ON; CPP_API=ON; CMAKE_FLAGS="-DBUILD_OPENFAST_CPP_API=$CPP_API -DGENERATE_TYPES=ON"
+    - os: osx
+      osx_image: xcode11
+      env: FC=/usr/local/bin/gfortran-7; DOUBLE_PRECISION=ON
+    - os: osx
+      osx_image: xcode11
+      env: FC=/usr/local/bin/gfortran-7; DOUBLE_PRECISION=OFF
 
+# macos dependency install
+addons:
+  homebrew:
+    packages:
+      - gcc@7
+      - yaml-cpp
+      - hdf5
+      - open-mpi
+    update: true
+
 before_install:
-    # mac configuration
-    - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update; fi
-    - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew upgrade python; fi
-    - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install gcc@7; fi
-
     # linux configuration
-    - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install gfortran; fi
-    - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install libblas-dev liblapack-dev; fi
-    - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then pyenv shell 3.6.3; fi
-
-    # intel compiler
-    # this build requires setting an environment variable https://docs.travis-ci.com/user/environment-variables#defining-encrypted-variables-in-travisyml
-    # INTEL_SERIAL_NUMBER=XXXX-XXXXXXXX
-    - if [[ -n "${TRAVIS_BUILD_INTEL}" ]] ; then wget 'https://raw.githubusercontent.com/nemequ/icc-travis/master/install-icc.sh'; fi
-    - if [[ -n "${TRAVIS_BUILD_INTEL}" ]] ; then chmod 755 install-icc.sh; fi
-    - if [[ -n "${TRAVIS_BUILD_INTEL}" ]] ; then ./install-icc.sh --components ifort,icc,mkl; source ~/.bashrc; fi
+    - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install gfortran libblas-dev liblapack-dev; fi
+    - if [[ "$TRAVIS_OS_NAME" == "linux" && "$CPP_API" == "ON" ]]; then sudo apt-get install libopenmpi-dev libyaml-cpp-dev libhdf5-dev libxml2-dev; fi
+    - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then pyenv shell 3.7.1; fi
 
     # common configuration
     - pip3 install numpy
 
 install:
     - mkdir build && cd build
-    - cmake .. -DBUILD_TESTING=ON -DDOUBLE_PRECISION=$DOUBLE_PRECISION -DBUILD_SHARED_LIBS=ON
-    - make -j 8 install
-
-matrix:
-  exclude:
-    - os: linux
-      env: FC=/usr/local/bin/gfortran-7; DOUBLE_PRECISION=ON
-    - os: linux
-      env: FC=/usr/local/bin/gfortran-7; DOUBLE_PRECISION=OFF
-    - os: osx
-      env: FC=/usr/bin/gfortran; DOUBLE_PRECISION=ON
-    - os: osx
-      env: FC=/usr/bin/gfortran; DOUBLE_PRECISION=OFF
-    - os: osx
-      env: FC=ifort; DOUBLE_PRECISION=ON; TRAVIS_BUILD_INTEL=YES
+    - cmake .. -DCMAKE_BUILD_TYPE=DEBUG -DBUILD_TESTING=ON -DBUILD_SHARED_LIBS=ON -DDOUBLE_PRECISION=$DOUBLE_PRECISION $CMAKE_FLAGS
+    - cat CMakeCache.txt
+    - make -j4 install
 
 script:
     # beamdyn unit tests
     - if [[ "$DOUBLE_PRECISION" == "ON" ]]; then ctest -VV -R beamdyn_utest; fi
 
     # beamdyn regression tests
-    - if [[ "$DOUBLE_PRECISION" == "ON" ]]; then ctest -VV -R bd_; fi
+    - if [[ "$DOUBLE_PRECISION" == "ON" ]]; then ctest -j4 -VV -R bd_; fi
 
     # subset of openfast regression tests
     # do not run
@@ -72,4 +65,3 @@ script:
     # CURRENTLY, TESTS FAIL WITH VERY MINOR DIFFERENCES
     # - ctest -VV -j 18 -I 1,1,1,2,5,6,8,9,10,11,12,13,14,18,19,22,23,24,25,26
     # - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then ctest -j 18 -I 1,1,1,2,5,6,8,9,10,11,12,13,14,18,19,22,23,24,25,26 ; fi
-