Merge pull request #176 from ImperialCollegeLondon/dev_blade_pitch_v2

Collective blade pitch PID control of wind turbines

.github/workflows/sharpy_tests.yaml

@@ -54,7 +54,7 @@ jobs:
           source activate sharpy_minimal
           git submodule init
           git submodule update
-          git fetch -t
+          git fetch --tags -f
           mkdir build && cd build
           cmake .. && make install -j 4 && cd ..
           pip install .

.gitignore

@@ -118,3 +118,7 @@ figs/*
 
 # sharpy extension
 *.sharpy
+
+# Exceptions
+# !tests/coupled/multibody/floating_wind_turbine/oc3_cs_v07.floating.h5 
+!tests/coupled/multibody/floating_wind_turbine/oc3_cs_v07.floating.h*

.version.json

@@ -1,6 +1,6 @@
 {
   "schemaVersion": 1,
   "label": "release version",
-  "message": "1.3",
+  "message": "2.0",
   "color": "green"
 }

CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## [2.0](https://github.com/imperialcollegelondon/sharpy/tree/2.0) (2022-07-04)
+
+[Full Changelog](https://github.com/imperialcollegelondon/sharpy/compare/1.3...2.0)
+
+**Implemented enhancements:**
+
+- Plot the aeroelastic mode shape to Paraview [\#202](https://github.com/ImperialCollegeLondon/sharpy/pull/202) ([ngoiz](https://github.com/ngoiz))
+- Enhanced linear solver [\#196](https://github.com/ImperialCollegeLondon/sharpy/pull/196) ([ngoiz](https://github.com/ngoiz))
+- Add pip support [\#175](https://github.com/ImperialCollegeLondon/sharpy/pull/175) ([DavidAnderegg](https://github.com/DavidAnderegg))
+
+**Fixed bugs:**
+
+- Flap inputs in state-space model not working in certain wing configurations [\#192](https://github.com/ImperialCollegeLondon/sharpy/issues/192)
+- Fix mass matrix generation for lumped masses in case of several masses per node [\#194](https://github.com/ImperialCollegeLondon/sharpy/pull/194) ([sduess](https://github.com/sduess))
+- Fix the sparse matrix in balancing ROM [\#186](https://github.com/ImperialCollegeLondon/sharpy/pull/186) ([AntonioWR](https://github.com/AntonioWR))
+
+**Closed issues:**
+
+- scipy used for direct balancing method [\#184](https://github.com/ImperialCollegeLondon/sharpy/issues/184)
+- Potential Issue in the balancing direct method [\#183](https://github.com/ImperialCollegeLondon/sharpy/issues/183)
+- Why no pip support? [\#171](https://github.com/ImperialCollegeLondon/sharpy/issues/171)
+
+**Merged pull requests:**
+
+- Contain write operations within with statements [\#195](https://github.com/ImperialCollegeLondon/sharpy/pull/195) ([ngoiz](https://github.com/ngoiz))
+- Support loading/saving state-spaces and gains to h5 files [\#188](https://github.com/ImperialCollegeLondon/sharpy/pull/188) ([ngoiz](https://github.com/ngoiz))
+- Update installation docs [\#187](https://github.com/ImperialCollegeLondon/sharpy/pull/187) ([nacho-carnicero](https://github.com/nacho-carnicero))
+- Unittest for nonlinear dynamic solver [\#185](https://github.com/ImperialCollegeLondon/sharpy/pull/185) ([sduess](https://github.com/sduess))
+- Change in the io-Settings to add thrust. [\#164](https://github.com/ImperialCollegeLondon/sharpy/pull/164) ([Eriklyy](https://github.com/Eriklyy))
+- UDP-Inout change for multiply cs\_surface\_deflections and loads/strain [\#162](https://github.com/ImperialCollegeLondon/sharpy/pull/162) ([Eriklyy](https://github.com/Eriklyy))
+- Update AsymptoticStability and FrequencyResponse post-processors [\#103](https://github.com/ImperialCollegeLondon/sharpy/pull/103) ([ngoiz](https://github.com/ngoiz))
+
 ## [1.3](https://github.com/imperialcollegelondon/sharpy/tree/1.3) (2021-11-11)
 
 [Full Changelog](https://github.com/imperialcollegelondon/sharpy/compare/v1.2.1...1.3)

docs/source/conf.py

@@ -74,17 +74,17 @@
 
 # General information about the project.
 project = 'SHARPy'
-copyright = '2021, LoCA Lab ICL'
+copyright = '2022, LoCA Lab ICL'
 author = 'Aeroelastics Lab, Imperial College London'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '1.3'
+version = '2.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.3'
+release = '2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/content/contributing.md

@@ -201,3 +201,37 @@ If you contribute, please make sure you know what branch to work from. If in dou
 Commit names are also important since they are the backbone of the code's change log. Please write concise commit titles
 and explain the main changes in the body of the commit message. An excellent guide on writing good commit messages can
 be found [here](https://chris.beams.io/posts/git-commit/).
+
+# For developers: 
+
+## Releasing a new SHARPy version
+
+In the release candidate branch:
+
+1. Update the version number in the docs configuration file `docs/source/conf.py`. Update variables `version` and `release`
+
+2. Update `version.json` file
+
+3. Update version in `sharpy/__init__.py` file
+
+4. Commit, push and wait for tests to pass
+
+5. Merge release candidate branch into `master` branch
+
+In the `master` branch:
+
+1. Run the [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator) tool locally with the following parameters:
+  ```
+  github_changelog_generator -u imperialcollegelondon -p sharpy -t <your_github_token> --future-release <new_release_version>
+  ```
+
+2. Push the changes to the `CHANGELOG.md` file
+  
+3. Create a release tag. IMPORTANT: ensure it is an *annotated* tag, otherwise the version and commit number in SHARPy will not display properly
+  ```
+  git tag -a <tagname>
+  git push origin --tags -f
+  ```
+  where `<tagname>` is something like `2.0`.
+  
+4. Create the GitHub release, choosing the newly created tag from the dropdown menu. Do not create a tag from the dropdown menu directly because it will not be an annotated tag