Merge branch 'rc-2.0'

.github/workflows/sharpy_no_test_needed.yaml

@@ -0,0 +1,18 @@
+name: Python package
+
+on:
+  pull_request:
+    branches:
+      - master
+      - develop
+      - 'rc*'
+    paths-ignore:
+      - '*.py'
+      - 'lib/**'
+      - '.github/workflows/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - run: 'echo "No changes to python files, submodules or workflows, no run required" '

.github/workflows/sharpy_tests.yaml

@@ -1,14 +1,24 @@
 name: Python package
 
-on: [push]
+on:
+  push:
+    paths:
+      - '*.py'
+      - 'lib/*'
+      - '.github/workflows/*'
+  pull_request:
+    branches:
+      - master
+      - develop
+      - 'rc*'
 
 jobs:
   build:
 
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6]
+        python-version: [3.7]
 
     steps:
       - uses: actions/checkout@v2
@@ -24,7 +34,7 @@ jobs:
       - name: Setup conda
         uses: s-weigand/setup-conda@v1
         with:
-          python-version: 3.6
+          python-version: 3.7
       - name: Pre-Install dependencies
         run: |
           gfortran --version
@@ -45,9 +55,9 @@ jobs:
           git submodule init
           git submodule update
           git fetch -t
-          source bin/sharpy_vars.sh
           mkdir build && cd build
           cmake .. && make install -j 4 && cd ..
+          pip install .
           pip install coverage
           coverage run -m unittest discover
       - name: Upload Coverage to Codecov

.gitignore

@@ -40,7 +40,7 @@ htmlcov/
 .cache
 nosetests.xml
 coverage.xml
-*,cover
+*.cover
 .hypothesis/
 
 # Translations
@@ -89,54 +89,31 @@ ENV/
 # Vim stuff
 *.*~
 *.swp
-*.txt
 *.h5
 
-# project dependant stuff
+# project dependent stuff
 lib/*.so
 output/*
 .idea
 
 # figure folders
 *figs/*
 
-*.csv
 *.eps
 *.vtu
 
-utils/eigen_debug/__init__\.py
-
-utils/eigen_debug/printers\.py
-
-tests/uvlm/\.DS_Store
-
-*/.DS_Store
 
 output*/
 
 snapshots/
 
-
-.DS_Store
-
-tests/coupled/dynamic/horten/BFF/
-
-tests/coupled/dynamic/horten/BFF2/
-
-tests/coupled/prescribed/goland_linear/model_diff/
-
+# OSX files
+*.DS_Store
 
 # linear tools / tests cases
 *.prof
-sharpy/linear/test/test_cases/*
-tests/linear/uvlm/figs/*
-tests/linear/uvlm/res/*
-cases/linear/coupled/figs/*
-cases/linear/coupled/res/*
 figs/*
 
-tests/linear/rom/figs/
-
 \.spyproject/
 
 # sharpy extension

.version.json

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

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