From 2d1894b5fe84df1580c24f5b1974d420178c1f40 Mon Sep 17 00:00:00 2001
From: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
Date: Thu, 5 Sep 2024 10:30:40 +0200
Subject: [PATCH 1/8] Add changelog entry.

---
 CHANGELOG.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1ad96d2c..1a63ecff 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 * Use `copy(deepcopy=True)` when checkpointing to make checkpointing more user-friendly and secure. IMPORTANT: might increase runtime, please open an issue if you face serious problems. [#172](https://github.com/precice/fenics-adapter/pull/172)
 * Add unit tests for checkpointing. [#173](https://github.com/precice/fenics-adapter/pull/173)
+* Remove checks for FEniCS installation and python3 from `setup.py` since the approach is deprecated. [#182](https://github.com/precice/fenics-adapter/pull/182)
 
 ## 2.1.0
 

From b3a9a280cb840aa91d6fa005adbb0a40f159e27f Mon Sep 17 00:00:00 2001
From: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
Date: Thu, 5 Sep 2024 11:40:44 +0200
Subject: [PATCH 2/8] Remove checks for FEniCS and python3 (#182)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Frédéric Simonis <simonisfrederic@gmail.com>
---
 setup.py | 23 -----------------------
 1 file changed, 23 deletions(-)

diff --git a/setup.py b/setup.py
index 1b277b9e..1f6d7126 100644
--- a/setup.py
+++ b/setup.py
@@ -1,29 +1,6 @@
 import os
 from setuptools import setup
 import versioneer
-import warnings
-
-# from https://stackoverflow.com/a/9079062
-import sys
-if sys.version_info[0] < 3:
-    raise Exception("fenicsprecice only supports Python3. Did you run $python setup.py <option>.? "
-                    "Try running $python3 setup.py <option>.")
-
-if sys.version_info[1] == 6 and sys.version_info[2] == 9:
-    warnings.warn("It seems like you are using Python version 3.6.9. There is a known bug with this Python version "
-                  "when running the tests (see https://github.com/precice/fenics-adapter/pull/61). If you want to "
-                  "run the tests, please install a different Python version.")
-
-try:
-    from fenics import *
-except ModuleNotFoundError:
-    warnings.warn("No FEniCS installation found on system. Please install FEniCS and check the installation.\n\n"
-                  "You can check this by running the command\n\n"
-                  "python3 -c 'from fenics import *'\n\n"
-                  "Please check https://fenicsproject.org/download/ for installation guidance.\n"
-                  "The installation will continue, but please be aware that your installed version of the "
-                  "fenics-adapter might not work as expected.")
-
 this_directory = os.path.abspath(os.path.dirname(__file__))
 with open(os.path.join(this_directory, 'README.md'), encoding='utf-8') as f:
     long_description = f.read()

From 250ccdb222caffb4d712bd6e06e1e9fff34c04d5 Mon Sep 17 00:00:00 2001
From: NiklasV <139122850+NiklasVin@users.noreply.github.com>
Date: Sat, 7 Sep 2024 13:08:56 +0200
Subject: [PATCH 3/8] Modify `setup.py` to avoid crash due to version 4.0.0 of
 `mpi4py` during installation (#181)

* Require mpi4py < 4

---------

Co-authored-by: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
---
 CHANGELOG.md | 1 +
 setup.py     | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1a63ecff..f5897b19 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 * Use `copy(deepcopy=True)` when checkpointing to make checkpointing more user-friendly and secure. IMPORTANT: might increase runtime, please open an issue if you face serious problems. [#172](https://github.com/precice/fenics-adapter/pull/172)
 * Add unit tests for checkpointing. [#173](https://github.com/precice/fenics-adapter/pull/173)
+* Add required version of `mpi4py` to `<4` to avoid crash during installation. [#181](https://github.com/precice/fenics-adapter/pull/181)
 * Remove checks for FEniCS installation and python3 from `setup.py` since the approach is deprecated. [#182](https://github.com/precice/fenics-adapter/pull/182)
 
 ## 2.1.0
diff --git a/setup.py b/setup.py
index 1f6d7126..df8b2120 100644
--- a/setup.py
+++ b/setup.py
@@ -16,6 +16,6 @@
       author_email='info@precice.org',
       license='LGPL-3.0',
       packages=['fenicsprecice'],
-      install_requires=['pyprecice>=3.0.0.0', 'scipy', 'numpy>=1.13.3, <2', 'mpi4py'],
+      install_requires=['pyprecice>=3.0.0.0', 'scipy', 'numpy>=1.13.3, <2', 'mpi4py<4'],
       test_suite='tests',
       zip_safe=False)

From 60c451e3f938c8a21df984b5776ef149dce7bee5 Mon Sep 17 00:00:00 2001
From: NiklasV <139122850+NiklasVin@users.noreply.github.com>
Date: Thu, 31 Oct 2024 08:33:32 +0100
Subject: [PATCH 4/8] Clarify installation procedure (#183)

* Add note regarding the externally-managed-environment error

* Provide commands that we use in tutorials.

---------

Co-authored-by: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5f97135c..234b240a 100644
--- a/README.md
+++ b/README.md
@@ -27,9 +27,18 @@ preCICE-adapter for the open source computing platform FEniCS.
 It is recommended to install [fenicsprecice from PyPI](https://pypi.org/project/fenicsprecice/) via
 
 ```bash
-pip3 install --user fenicsprecice
+pip3 install fenicsprecice
 ```
 
+For more recent pip versions you may encounter the error `error: externally-managed-environment` during installation of the fenicsprecice. You can read why [here](https://packaging.python.org/en/latest/specifications/externally-managed-environments/). In this case, it is recommended to create a virtual environment and install the package in the virtual environment. The following commands will create the virtual environment `venv_name` at the location `path/of/your/venv/`:
+
+```bash
+python3 -m venv --system-site-packages path/of/your/venv/venv_name
+. path/of/your/venv/venv_name/bin/activate
+```
+
+You can replace `path/of/your/venv/venv_name` with the location and name you want to use for your virtual environment. The command `--system-size-packages` will allow the virtual environment to access the FEniCS installation on your system. Refer to the [Python documentation](https://docs.python.org/3/library/venv.html) for further details on virtual environments.
+
 This should work out of the box, if all dependencies are installed correctly. If you face problems during installation or you want to run the tests, see below for a list of dependencies and alternative installation procedures
 
 ### Clone this repository and use pip3

From 06ae7ade63be3d5cdbe9b195e5289c7604068b59 Mon Sep 17 00:00:00 2001
From: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
Date: Thu, 31 Oct 2024 08:41:25 +0100
Subject: [PATCH 5/8] Clarify how to merge in ReleaseGuide.md

---
 docs/ReleaseGuide.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/ReleaseGuide.md b/docs/ReleaseGuide.md
index 6365b0dc..81ce34a7 100644
--- a/docs/ReleaseGuide.md
+++ b/docs/ReleaseGuide.md
@@ -19,7 +19,7 @@ Before starting this process make sure to check that all relevant changes are in
 
     a) If a pre-release is made: Directly hit the "Publish release" button in your Release Draft. Now you can check the artifacts (e.g. release on [PyPI](https://pypi.org/project/fenicsprecice/#history)) of the release. *Note:* As soon as a new tag is created github actions will take care of deploying the new version on PyPI using [this workflow](https://github.com/precice/fenics-adapter/actions?query=workflow%3A%22Upload+Python+Package%22).
 
-    b) If this is a "real" release: As soon as one approving review is made, merge the release PR (`fenics-adapter-vX.X.X`) into `master`.
+    b) If this is a "real" release: As soon as one approving review is made, merge the release PR (`fenics-adapter-vX.X.X`) into `master`. Use **Merge pull request**, don't squash the commits.
 
 5. Merge `master` into `develop` for synchronization of `develop`.
 

From c8ad11cf7bfe03897737cf0809dcb516d114d7e8 Mon Sep 17 00:00:00 2001
From: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
Date: Fri, 25 Oct 2024 17:26:18 +0200
Subject: [PATCH 6/8] bump version

---
 CHANGELOG.md | 2 +-
 CITATION.cff | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index f5897b19..153b9802 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # FEniCS-preCICE adapter changelog
 
-## latest
+## v2.2.0
 
 * Use `copy(deepcopy=True)` when checkpointing to make checkpointing more user-friendly and secure. IMPORTANT: might increase runtime, please open an issue if you face serious problems. [#172](https://github.com/precice/fenics-adapter/pull/172)
 * Add unit tests for checkpointing. [#173](https://github.com/precice/fenics-adapter/pull/173)
diff --git a/CITATION.cff b/CITATION.cff
index 759c6345..fa1d48a9 100644
--- a/CITATION.cff
+++ b/CITATION.cff
@@ -32,7 +32,7 @@ abstract: >-
   preCICE-adapter for the open source computing platform
   FEniCS.
 license: LGPL-3.0
-version: 2.1.0
+version: 2.2.0
 preferred-citation:
   title: "FEniCS-preCICE: Coupling FEniCS to other Simulation Software"
   type: "article"

From 12891453f5c34695b21d8fd0ccd7208ca42df114 Mon Sep 17 00:00:00 2001
From: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
Date: Thu, 31 Oct 2024 10:38:03 +0100
Subject: [PATCH 7/8] Include creation of post-tag bump like in python
 bindings.

---
 docs/ReleaseGuide.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/docs/ReleaseGuide.md b/docs/ReleaseGuide.md
index 81ce34a7..057ed6b3 100644
--- a/docs/ReleaseGuide.md
+++ b/docs/ReleaseGuide.md
@@ -26,3 +26,32 @@ Before starting this process make sure to check that all relevant changes are in
 6. If everything is in order up to this point then the new version can be released by hitting the "Publish release" button in your Release Draft.
 
 7. Now there should be a tag for the release. Re-run the [docker release workflow `build-docker.yml` via dispatch](https://github.com/precice/fenics-adapter/actions/workflows/build-docker.yml) such that the correct version is picked up by `versioneer`. Check the version in the container via `docker pull precice/fenics-adapter`, then `docker run -ti precice/fenics-adapter`, and inside the container `$ python3 -c "import fenicsprecice; print(fenicsprecice.__version__)"`.
+
+8. Add an empty commit (details https://github.com/precice/python-bindings/issues/109) on master by running the steps:
+
+    ```bash
+    git checkout master
+    git commit --allow-empty -m "post-tag bump"
+    git push
+    ```
+
+    Check that everything is in order via `git log`. Important: The `tag` and `origin/master` should not point to the same commit. For example:
+
+    ```bash
+    commit 9d0d6bf978b2363c7ee041201df4322f930dd456 (HEAD -> master)
+    Author: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
+    Date:   Thu Oct 31 08:52:07 2024 +0100
+
+        post-tag bump
+
+    commit 0d8eecb54b4bc582f33f5f38fca77dfe6161a237 (origin/master)
+    Merge: f3abeb0 8ca28ae
+    Author: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
+    Date:   Thu Oct 31 08:41:36 2024 +0100
+
+        Merge pull request #184 from precice/fenics-adapter-v2.2.0
+
+        Release v2.2.0
+    ```
+
+    For more details refer to https://github.com/precice/python-bindings/issues/109 and https://github.com/python-versioneer/python-versioneer/issues/217.

From 3de561dd47f9f117c5f2e51e44870ae6626a7506 Mon Sep 17 00:00:00 2001
From: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
Date: Thu, 7 Nov 2024 13:20:21 +0100
Subject: [PATCH 8/8] Fix bare links.

---
 docs/ReleaseGuide.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/ReleaseGuide.md b/docs/ReleaseGuide.md
index 057ed6b3..3ee4eaa7 100644
--- a/docs/ReleaseGuide.md
+++ b/docs/ReleaseGuide.md
@@ -27,7 +27,7 @@ Before starting this process make sure to check that all relevant changes are in
 
 7. Now there should be a tag for the release. Re-run the [docker release workflow `build-docker.yml` via dispatch](https://github.com/precice/fenics-adapter/actions/workflows/build-docker.yml) such that the correct version is picked up by `versioneer`. Check the version in the container via `docker pull precice/fenics-adapter`, then `docker run -ti precice/fenics-adapter`, and inside the container `$ python3 -c "import fenicsprecice; print(fenicsprecice.__version__)"`.
 
-8. Add an empty commit (details https://github.com/precice/python-bindings/issues/109) on master by running the steps:
+8. Add an empty commit (details see [here](https://github.com/precice/python-bindings/issues/109)) on master by running the steps:
 
     ```bash
     git checkout master
@@ -54,4 +54,4 @@ Before starting this process make sure to check that all relevant changes are in
         Release v2.2.0
     ```
 
-    For more details refer to https://github.com/precice/python-bindings/issues/109 and https://github.com/python-versioneer/python-versioneer/issues/217.
+    For more details refer to [this issue](https://github.com/precice/python-bindings/issues/109) and [this issue](https://github.com/python-versioneer/python-versioneer/issues/217).