Skip to content

Commit f2419c5

Browse files
rafmudafrafmudaf
authored
Release version 2.3.0
Merge pull request #433: dev into master
2 parents e4faf27 + d78f419 commit f2419c5

87 files changed

Lines changed: 5491 additions & 4227 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/actions/compile-and-test/Dockerfile‎

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,9 @@
1616

1717
FROM rafmudaf/openfast-ubuntu:dev
1818

19-
# Move into the openfast directory and update
19+
# Move into the openfast directory
2020
WORKDIR /openfast
21-
RUN git fetch
22-
RUN git pull
23-
RUN git submodule update
2421

25-
# Move into the "build" directory and compile
26-
WORKDIR /openfast/build
27-
RUN cmake ..
28-
RUN make -j4 install
22+
COPY entrypoint.sh /entrypoint.sh
2923

30-
# Run the tests
31-
32-
# BeamDyn-specific tests
33-
RUN ctest -VV -j7 -R bd_
34-
RUN ctest -VV -R beamdyn_utest
35-
36-
# OpenFAST linearization tests
37-
RUN ctest -VV -j4 -L linear
38-
39-
# Subset of OpenFAST regression tests; do not run
40-
## - 3, 4, 7, 14, 15, 16, since the free yaw is not well trusted
41-
## - 9 because its super sensitive
42-
## - 19, 20 because theyre too long
43-
RUN ctest -VV -j8 -I 1,1,1,2,5,6,8,10,11,12,13,17,18,21,22,23,24,25
24+
ENTRYPOINT ["/entrypoint.sh"]

‎.github/actions/compile-and-test/entrypoint.sh‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#!/bin/bash
2+
3+
git fetch origin ${GITHUB_REF}:CI
4+
git checkout CI
5+
git submodule update
6+
7+
# Print the current git info
8+
echo `git status`
9+
echo `git log -1`
10+
cd /openfast/reg_tests/r-test
11+
echo `git status`
12+
echo `git log -1`
13+
cd /openfast
14+
15+
# Move into the "build" directory, remove the old reg tests, and compile
16+
cd /openfast/build
17+
rm -rf reg_tests
18+
cmake ..
19+
make -j4 install
20+
21+
# Run the tests
22+
23+
# NWTC Library tests
24+
ctest -VV -R nwtc_library_utest
25+
26+
# BeamDyn-specific tests
27+
ctest -VV -j7 -R bd_
28+
ctest -VV -R beamdyn_utest
29+
30+
# OpenFAST linearization tests
31+
# Dont run these in parallel, copying the case files can fail in a race condition
32+
ctest -VV -L linear
33+
34+
# Subset of OpenFAST regression tests; do not run
35+
## - 9, 16 because they're very sensitive
36+
## - 19, 20 because theyre too long
37+
## - 17, 22, 23 becuase we dont know why they fail :(
38+
ctest -VV -j8 -I 1,1,1,2,3,4,5,6,7,8,10,11,12,13,14,15,18,21,24,25

‎README.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
OpenFAST
22
========
33

4-
|travisci| |nbsp| |rtfd|
4+
|actions| |nbsp| |rtfd|
55

6-
.. |travisci| image:: https://travis-ci.org/OpenFAST/openfast.svg?branch=dev
7-
:target: https://travis-ci.org/OpenFAST/openfast
6+
.. |actions| image:: https://github.com/openfast/openfast/workflows/OpenFAST%20Build%20and%20Test/badge.svg?branch=dev
7+
:target: https://github.com/OpenFAST/openfast/actions?query=workflow%3A%22OpenFAST+Build+and+Test%22
88
:alt: Build Status
99
.. |rtfd| image:: https://readthedocs.org/projects/openfast/badge/?version=dev
1010
:target: https://openfast.readthedocs.io/en/dev
@@ -112,7 +112,7 @@ Details for compiling
112112
`compiling <http://openfast.readthedocs.io/en/latest/source/install/index.html>`_,
113113
`using <http://openfast.readthedocs.io/en/latest/source/user/index.html>`_, and
114114
`developing <http://openfast.readthedocs.io/en/latest/source/dev/index.html>`_
115-
OpenFAST on Unux-based and Windows machines are available at `readthedocs <http://openfast.readthedocs.io>`_.
115+
OpenFAST on Unix-based and Windows machines are available at `readthedocs <http://openfast.readthedocs.io>`_.
116116

117117
Nightly Testing
118118
---------------

‎docs/conf.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,9 @@ def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
115115
# built documents.
116116
#
117117
# The short X.Y version.
118-
version = u'2.1'
118+
version = u'2.3'
119119
# The full version, including alpha/beta/rc tags.
120-
release = u'v2.1.0'
120+
release = u'v2.3.0'
121121

122122
# The language for content autogenerated by Sphinx. Refer to documentation
123123
# for a list of supported languages.

‎docs/source/dev/build_doc.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ file:
2727
Doxygen and Graphviz can be installed directly from their website or with a
2828
package manager like ``brew``, ``yum``, or ``apt``.
2929

30+
The result of building the documentation locally will be a set of
31+
HTML files and their accompanying required files. The main HTML file
32+
will exist ``openfast/build/docs/html/index.html``. This file can
33+
be opened with any browser to view and navigate the locally-generated
34+
documentation as if it were any other web site.
35+
3036
Pure python build
3137
~~~~~~~~~~~~~~~~~
3238
If CMake and Make are not available on your system, the documentation can

‎docs/source/dev/github_workflow.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,13 @@ In OpenFAST development, the typical workflow follows this procedure:
8282

8383
.. code-block:: bash
8484
85+
# This adds the remote
8586
git remote add upstream https://github.com/OpenFAST/OpenFAST
8687
88+
# This downloads all the info in the remote, but it doesnt change
89+
# the local source code
90+
git fetch --all
91+
8792
4. Create a feature branch for active development starting from the OpenFAST
8893
``dev`` branch and check it out
8994

‎docs/source/testing/regression_test.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The following packages are required for regression testing:
6868
- Python 3+
6969
- Numpy
7070
- CMake and CTest (Optional)
71-
- matplotlib (Optional)
71+
- Bokeh 1.4 (Optional)
7272

7373
.. _python_driver:
7474

@@ -100,7 +100,7 @@ executing with the help option:
100100
optional arguments:
101101
-h, --help show this help message and exit
102102
-p [Plotting-Flag], -plot [Plotting-Flag]
103-
bool to include matplotlib plots in failed cases
103+
bool to include plots in failed cases
104104
-n [No-Execution], -no-exec [No-Execution]
105105
bool to prevent execution of the test cases
106106
-v [Verbose-Flag], -verbose [Verbose-Flag]
@@ -366,7 +366,7 @@ included Python driver.
366366
# optional arguments:
367367
# -h, --help show this help message and exit
368368
# -p [Plotting-Flag], -plot [Plotting-Flag]
369-
# bool to include matplotlib plots in failed cases
369+
# bool to include plots in failed cases
370370
# -n [No-Execution], -no-exec [No-Execution]
371371
# bool to prevent execution of the test cases
372372
# -v [Verbose-Flag], -verbose [Verbose-Flag]

‎docs/source/testing/unit_test.rst‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -110,18 +110,15 @@ structured as
110110
Each unit test must be contained in a unique file called
111111
``test_[SUBROUTINE].F90`` where ``[SUBROUTINE]`` is the code block being
112112
tested. Finally, update the CMake configuration for building a module's unit
113-
test executable with the appropriate list of test subroutines
114-
in ``openfast/unit_tests/CMakeLists.txt`` using the following format:
115-
116-
.. code-block:: cmake
117-
118-
set(testlist
119-
test_SUBROUTINE1
120-
test_SUBROUTINE2
121-
test_SUBROUTINE3
122-
)
123-
# it is important to keep the quotes around "${testlist}" in the call below
124-
build_utest("module_name" "${testlist}")
113+
test executable by copying the BeamDyn CMake configuration into a new module
114+
directory:
115+
116+
.. code-block:: bash
117+
118+
cp -r openfast/unit_tests/beamdyn openfast/unit_tests/[module]
119+
120+
Then, modify the new ``CMakeLists.txt`` with the appropriate list of test
121+
subroutines and module name variables.
125122

126123
For reference, a template unit test file is included at
127124
``openfast/unit_tests/test_SUBROUTINE.F90``. Each unit test should fully test

‎docs/source/user/aerodyn/examples/ad_airfoil_example.inp‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
! "NREL/TP-442-7817 Appendix B, Viterna used aspect ratio=11"
33
! note that this file uses Marshall Buhl's new input file processing; start all comment lines with !
44
! ------------------------------------------------------------------------------
5-
"DEFAULT" InterpOrd ! Interpolation order to use for quasi-steady table lookup {1=linear; 3=cubic spline; "default"} [default=3]
5+
"DEFAULT" InterpOrd ! Interpolation order to use for quasi-steady table lookup {1=linear; 3=cubic spline; "default"} [default=1]
66
! ------------------------------------------------------------------------------
77
1 NonDimArea ! The non-dimensional area of the airfoil (area/chord^2) (set to 1.0 if unsure or unneeded)
8-
67 NumCoords ! The number of coordinates in the airfoil shape file (including an extra coordinate for airfoil reference). Set to zero if coordinates…
8+
67 NumCoords ! The number of coordinates in the airfoil shape file (including an extra coordinate for airfoil reference).
99
! ......... x-y coordinates are next if NumCoords > 0 .............
1010
! x-y coordinate of airfoil reference
1111
! x/c y/c
@@ -79,12 +79,12 @@
7979
0.996141 0.000290
8080
1.000000 0.000000
8181
! ------------------------------------------------------------------------------
82-
1 NumTabs ! Number of airfoil tables in this file. Each table must have lines for Re and Ctrl.
82+
1 NumTabs ! Number of airfoil tables in this file.
8383
! ------------------------------------------------------------------------------
8484
! data for table 1
8585
! ------------------------------------------------------------------------------
8686
0.75 Re ! Reynolds number in millions
87-
0 Ctrl ! Control setting (must be 0 for current AirfoilInfo)
87+
0 UserProp ! User property (control) setting
8888
true InclUAdata ! Is unsteady aerodynamics data included in this table? If TRUE, then include 30 UA coefficients below this line
8989
!........................................
9090
-0.38 alpha0 ! 0-lift angle of attack, depends on airfoil.

‎docs/source/user/aerodyn/examples/ad_primary_example.inp‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ True TIDrag - Include the drag term in the tangential-induc
3434
1 UAMod - Unsteady Aero Model Switch (switch) {1=Baseline model (Original), 2=Gonzalez's variant (changes in Cn,Cc,Cm), 3=Minemma/Pierce variant (changes in Cc and Cm)} [used only when AFAeroMod=2]
3535
FALSE FLookup - Flag to indicate whether a lookup for f' will be calculated (TRUE) or whether best-fit exponential equations will be used (FALSE); if FALSE S1-S4 must be provided in airfoil input files (flag) [used only when AFAeroMod=2]
3636
====== Airfoil Information =========================================================================
37+
1 AFTabMod - Interpolation method for multiple airfoil tables {1=1D interpolation on AoA (first table only); 2=2D interpolation on AoA and Re; 3=2D interpolation on AoA and UserProp} (-)
3738
1 InCol_Alfa - The column in the airfoil tables that contains the angle of attack (-)
3839
2 InCol_Cl - The column in the airfoil tables that contains the lift coefficient (-)
3940
3 InCol_Cd - The column in the airfoil tables that contains the drag coefficient (-)

0 commit comments

Comments
 (0)