Update v6 with latest changes on master

.github/workflows/ci_pipeline.yml

@@ -35,23 +35,23 @@ jobs:
         run: |
           flakeheaven lint --benchmark pySDC
 
-  mirror_to_gitlab:
+#   mirror_to_gitlab:
 
-    runs-on: ubuntu-latest
+#     runs-on: ubuntu-latest
 
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v1
+#     steps:
+#       - name: Checkout
+#         uses: actions/checkout@v1
 
-      - name: Mirror
-        uses: jakob-fritz/github2lab_action@main
-        env:
-          MODE: 'mirror' # Either 'mirror', 'get_status', or 'both'
-          GITLAB_TOKEN: ${{ secrets.GITLAB_SECRET_H }}
-          FORCE_PUSH: "true"
-          GITLAB_HOSTNAME: "codebase.helmholtz.cloud"
-          GITLAB_PROJECT_ID: "3525"
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#       - name: Mirror
+#         uses: jakob-fritz/github2lab_action@main
+#         env:
+#           MODE: 'mirror' # Either 'mirror', 'get_status', or 'both'
+#           GITLAB_TOKEN: ${{ secrets.GITLAB_SECRET_H }}
+#           FORCE_PUSH: "true"
+#           GITLAB_HOSTNAME: "codebase.helmholtz.cloud"
+#           GITLAB_PROJECT_ID: "3525"
+#           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   user_cpu_tests_linux:
     runs-on: ubuntu-latest
@@ -121,31 +121,31 @@ jobs:
           pytest --continue-on-collection-errors -v --durations=0 pySDC/tests -m ${{ matrix.env }}
 
 
-  wait_for_gitlab:
-    runs-on: ubuntu-latest
+#   wait_for_gitlab:
+#     runs-on: ubuntu-latest
 
-    needs:
-      - mirror_to_gitlab
+#     needs:
+#       - mirror_to_gitlab
 
-    steps:
-      - name: Wait
-        uses: jakob-fritz/github2lab_action@main
-        env:
-          MODE: 'get_status' # Either 'mirror', 'get_status', or 'both'
-          GITLAB_TOKEN: ${{ secrets.GITLAB_SECRET_H }}
-          FORCE_PUSH: "true"
-          GITLAB_HOSTNAME: "codebase.helmholtz.cloud"
-          GITLAB_PROJECT_ID: "3525"
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#     steps:
+#       - name: Wait
+#         uses: jakob-fritz/github2lab_action@main
+#         env:
+#           MODE: 'get_status' # Either 'mirror', 'get_status', or 'both'
+#           GITLAB_TOKEN: ${{ secrets.GITLAB_SECRET_H }}
+#           FORCE_PUSH: "true"
+#           GITLAB_HOSTNAME: "codebase.helmholtz.cloud"
+#           GITLAB_PROJECT_ID: "3525"
+#           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-#      - name: Get and prepare artifacts
-#        run: |
-#          pipeline_id=$(curl --header "PRIVATE-TOKEN: ${{ secrets.GITLAB_SECRET_H }}" --silent "https://gitlab.hzdr.de/api/v4/projects/3525/repository/commits/${{ github.head_ref || github.ref_name }}" | jq '.last_pipeline.id')
-#          job_id=$(curl --header "PRIVATE-TOKEN: ${{ secrets.GITLAB_SECRET_H }}" --silent "https://gitlab.hzdr.de/api/v4/projects/3525/pipelines/$pipeline_id/jobs" |  jq '.[] | select( .name == "bundle" ) | select( .status == "success" ) | .id')
-#          curl --output artifacts.zip "https://gitlab.hzdr.de/api/v4/projects/3525/jobs/$job_id/artifacts"
-#          rm -rf data
-#          unzip artifacts.zip
-#          ls -ratl
+# #      - name: Get and prepare artifacts
+# #        run: |
+# #          pipeline_id=$(curl --header "PRIVATE-TOKEN: ${{ secrets.GITLAB_SECRET_H }}" --silent "https://gitlab.hzdr.de/api/v4/projects/3525/repository/commits/${{ github.head_ref || github.ref_name }}" | jq '.last_pipeline.id')
+# #          job_id=$(curl --header "PRIVATE-TOKEN: ${{ secrets.GITLAB_SECRET_H }}" --silent "https://gitlab.hzdr.de/api/v4/projects/3525/pipelines/$pipeline_id/jobs" |  jq '.[] | select( .name == "bundle" ) | select( .status == "success" ) | .id')
+# #          curl --output artifacts.zip "https://gitlab.hzdr.de/api/v4/projects/3525/jobs/$job_id/artifacts"
+# #          rm -rf data
+# #          unzip artifacts.zip
+# #          ls -ratl
 
 
   post-processing:
@@ -156,7 +156,7 @@ jobs:
     needs:
       - lint
       - user_cpu_tests_linux
-      - wait_for_gitlab
+#       - wait_for_gitlab
 
     defaults:
       run:
@@ -188,7 +188,10 @@ jobs:
         run: |
           pip install genbadge[all]
           genbadge coverage -i coverage.xml -o htmlcov/coverage-badge.svg
-
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+
 #      - name: Generate benchmark report
 #        uses: pancetta/github-action-benchmark@v1
 #        if: ${{ (!contains(github.event.head_commit.message, '[CI-no-benchmarks]')) && (github.event_name == 'push') }}

README.rst

@@ -1,3 +1,8 @@
+|badge-ga|
+|badge-ossf|
+|badge-cc|
+|zenodo|
+
 Welcome to pySDC!
 =================
 
@@ -74,3 +79,11 @@ This project has received funding from the `European High-Performance Computing
 The JU receives support from the European Union’s Horizon 2020 research and innovation programme and Belgium, France, Germany, and Switzerland.
 This project also received funding from the `German Federal Ministry of Education and Research <https://www.bmbf.de/bmbf/en/home/home_node.html>`_ (BMBF) grant 16HPC047.
 The project also received help from the `Helmholtz Platform for Research Software Engineering - Preparatory Study (HiRSE_PS) <https://www.helmholtz-hirse.de/>`_.
+
+
+.. |badge-ga| image:: https://github.com/Parallel-in-Time/pySDC/actions/workflows/ci_pipeline.yml/badge.svg?branch=master
+    :target: https://github.com/Parallel-in-Time/pySDC/actions/workflows/ci_pipeline.yml
+.. |badge-ossf| image:: https://bestpractices.coreinfrastructure.org/projects/6909/badge
+    :target: https://bestpractices.coreinfrastructure.org/projects/6909
+.. |badge-cc| image:: https://codecov.io/gh/Parallel-in-Time/pySDC/branch/master/graph/badge.svg?token=hpP18dmtgS 
+    :target: https://codecov.io/gh/Parallel-in-Time/pySDC

pySDC/core/BaseTransfer.py

@@ -83,7 +83,7 @@ def restrict(self):
         """
         Space-time restriction routine
 
-        The routine applies the spatial restriction operator to teh fine values on the fine nodes, then reevaluates f
+        The routine applies the spatial restriction operator to the fine values on the fine nodes, then reevaluates f
         on the coarse level. This is used for the first part of the FAS correction tau via integration. The second part
         is the integral over the fine values, restricted to the coarse level. Finally, possible tau corrections on the
         fine level are restricted as well.

pySDC/core/Collocation.py

@@ -90,7 +90,7 @@ def __init__(self, num_nodes=None, tleft=0, tright=1, node_type='LEGENDRE', quad
         self.node_type = node_type
         self.quad_type = quad_type
 
-        # Instanciate attributes
+        # Instantiate attributes
         self.nodeGenerator = NodesGenerator(self.node_type, self.quad_type)
         if self.node_type == 'EQUID':
             self.order = num_nodes

pySDC/core/Controller.py

@@ -3,10 +3,10 @@
 import sys
 import numpy as np
 
-from pySDC.core import Hooks as hookclass
 from pySDC.core.BaseTransfer import base_transfer
 from pySDC.helpers.pysdc_helper import FrozenClass
 from pySDC.implementations.convergence_controller_classes.check_convergence import CheckConvergence
+from pySDC.implementations.hooks.default_hook import DefaultHooks
 
 
 # short helper class to add params as attributes
@@ -40,11 +40,16 @@ def __init__(self, controller_params, description):
             controller_params (dict): parameter set for the controller and the steps
         """
 
-        # check if we have a hook on this list. if not, use default class.
-        controller_params['hook_class'] = controller_params.get('hook_class', hookclass.hooks)
-        self.__hooks = controller_params['hook_class']()
+        # check if we have a hook on this list. If not, use default class.
+        self.__hooks = []
+        hook_classes = [DefaultHooks]
+        user_hooks = controller_params.get('hook_class', [])
+        hook_classes += user_hooks if type(user_hooks) == list else [user_hooks]
+        [self.add_hook(hook) for hook in hook_classes]
+        controller_params['hook_class'] = controller_params.get('hook_class', hook_classes)
 
-        self.hooks.pre_setup(step=None, level_number=None)
+        for hook in self.hooks:
+            hook.pre_setup(step=None, level_number=None)
 
         self.params = _Pars(controller_params)
 
@@ -101,6 +106,20 @@ def __setup_custom_logger(level=None, log_to_file=None, fname=None):
         else:
             pass
 
+    def add_hook(self, hook):
+        """
+        Add a hook to the controller which will be called in addition to all other hooks whenever something happens.
+        The hook is only added if a hook of the same class is not already present.
+
+        Args:
+            hook (pySDC.Hook): A hook class that is derived from the core hook class
+
+        Returns:
+            None
+        """
+        if hook not in [type(me) for me in self.hooks]:
+            self.__hooks += [hook()]
+
     def welcome_message(self):
         out = (
             "Welcome to the one and only, really very astonishing and 87.3% bug free"
@@ -262,7 +281,7 @@ def add_convergence_controller(self, convergence_controller, description, params
         Args:
             convergence_controller (pySDC.ConvergenceController): The convergence controller to be added
             description (dict): The description object used to instantiate the controller
-            params (dict): Parametes for the convergence controller
+            params (dict): Parameters for the convergence controller
             allow_double (bool): Allow adding the same convergence controller multiple times
 
         Returns:
@@ -308,3 +327,15 @@ def get_convergence_controllers_as_table(self, description):
             out += f'\n{user_added}|{i:3} | {C.params.control_order:5} | {type(C).__name__}'
 
         return out
+
+    def return_stats(self):
+        """
+        Return the merged stats from all hooks
+
+        Returns:
+            dict: Merged stats from all hooks
+        """
+        stats = {}
+        for hook in self.hooks:
+            stats = {**stats, **hook.return_stats()}
+        return stats