Release [version number here] (needs to be adapted for pytrnsys)

This issue is intended as a template. A "copy" should be made of this issue for each release. Unfortunately, GitHub doesn't support copying issues, hence you'll need to manually copy and paste this template's body and title text to a new issue for your release. In your copy, delete this boldface text. Now you're ready to go: good luck with the release!

Usage and definitions

Work through the check-boxed items one after the other.

Let y denote this release's version number and x denote the previous release's version number.

Preliminaries

[ ] Version number inserted into issue title.
[ ] Added issue to Kanban project.

Manual tests

[ ] Create a new project and call it release-y-tests.
[ ] Drag a collector into the project.
[ ] Drag a storage tank into the project and place it to the collector's right. Call it SH and don't add any ports or heat exchangers yet.
[ ] Drag a radiator into the project and place it to the tank's right.
[ ] Drag a pump into the project and place it between the collector and the tank. Align it vertically with the tank's bottom.
[ ] Double click on the pump and check the horizontal flip check box. The icon should flip.
[ ] Drag a pump into the project and place it between the tank and the radiator. Align it vertically with the tank's top. Your project should currently look like this:
[ ] Double click on the storage tank to open the storage tank configuration dialog.
[ ] Add a heat exchanger called Hx on the left. Make it extend from 60% to 10%.
[ ] Close the dialog by hitting the OK button.
[ ] Re-open the dialog by double-clicking on the storage tank.
[ ] Add a direct port pair on the right from 99% to 1%.
[ ] Add a heat exchanger on the right from 80% to 40% and call it Hx2.
[ ] Add a direct port pair on the left from 20% to 50%. Your storage tank should look like this now:
[ ] Modify the direct port on the right by flipping its ports' heights around: make it extend from 1% to 99%.
[ ] Delete the heat exchanger on the right.
[ ] Change the upper port of the heat exchanger on the on the left to be at 70% (leave field for lower port empty: it should be left as is at 10%).
[ ] Delete the direct port pair on the left.
[ ] Connect the pipes like so: Pay attention to the "direction" of the pipes as indicated by their color gradient.
[ ] Rename one of the pipes
[ ] Hit the Run the massflow solver button. Randomized mass flows will be visualized.
[ ] Verify there is mass flow in the left and right loop.
[ ] Close the window and save the project.
[ ] Open the project release-y-tests.
[ ] Check that the name of the renamed pipe is persisted.
[ ] Hit the Run the massflow solver button. Randomized mass flows will be visualized.
[ ] Verify there is mass flow in the left and right loop.

Create release

Change the version mentioned in the README.md's installation instructions to y.
Commit and push your changes to README.md
Create a new release on GitHub here: https://github.com/SPF-OST/pytrnsys_gui/releases/new. Follow the semantic versioning convention (or see "Semantic versioning for the impatient" below) when coming up with version numbers.
Copy the directory requirements/releases/x (including its contained files) to requirements/releases/y
Update requirements/releases/y: set the pytrnsys-gui version to y: pytrnsys-gui==y
Run dev-tools/compileRequirementsTxts.py -P pytrnsys-gui
Revert all changed requirements.txt and requirements.in files except the ones under requirements/releases/y.
Compare the contents of requirements/releases/y/requirements.txt to requirements/releases/y/requirements.txt (only the version of pytrnsys-gui and any package whose version you've explicitely changed [or which you've added/ removed] should have changed)
Add the files under requirements/releases/y to the repository, commit and push.

Test the released package

[ ] Install package according to the user installation section in the README.md.
[ ] Launch the GUI by double-clicking on <your installation folder>\Scripts\pytrnsys-gui.exe.
[ ] Open the example project in <your installation folder>\pytrnsys_gui_data\examples\TRIHP_dualSource.

Semantic versioning for the impatient

Semantic versioning basically means (quoting from semver.org)

Given a version number MAJOR.MINOR.PATCH, increment the:

    1. MAJOR version when you make incompatible API changes,
    2. MINOR version when you add functionality in a backwards compatible manner, and
    3. PATCH version when you make backwards compatible bug fixes.

SPF-OST / pytrnsys