From cbf9fae81835a745e5e0f56f4de44228f959362d Mon Sep 17 00:00:00 2001 From: Magnus Hagdorn Date: Wed, 18 Dec 2024 16:51:44 +0100 Subject: [PATCH 01/13] replace words --- paper.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paper.tex b/paper.tex index ffb03bf..039f1d8 100644 --- a/paper.tex +++ b/paper.tex @@ -249,7 +249,7 @@ \section{Vision}% In this section, we describe our vision of central RSE units at research institutions in Germany. As these institutions include universities, other colleges, as well as large associations like Max-Planck, Helmholtz, Fraunhofer, or Leibniz, they show a wide variety in organisational structure as well as internal scientific diversity. -Thus, there can be no single optimal concept of such an RSE unit for all research institutions in Germany. +Thus, there can be no perfect model of such an RSE unit for all research institutions in Germany. We instead describe modular components that can be mixed and matched based on the respective local environment. We have identified nine modules that can make up an RSE unit. From e76098727bbb866aafa788b79438e56c8abcdcdd Mon Sep 17 00:00:00 2001 From: Magnus Hagdorn Date: Wed, 18 Dec 2024 16:54:15 +0100 Subject: [PATCH 02/13] I do think this belongs into Module 1 --- paper.tex | 1 - 1 file changed, 1 deletion(-) diff --git a/paper.tex b/paper.tex index 039f1d8..c993870 100644 --- a/paper.tex +++ b/paper.tex @@ -258,7 +258,6 @@ \section{Vision}% Thus, it is likely that no two RSE units will be, or should be, alike. However, these nine modules together with assumed weights are part of a simple model of an RSE group which provides both a quick overview of an individual group as well as a way to compare groups. The nine modules are described below. -\todo{FL:\@ Introduce the hub-spokes terminology.} \subsection{Module 1: Foster a local Network of RSEs}% \label{sec:network} From 84896bf87ae8fb1d0589256eccb08f0406762acf Mon Sep 17 00:00:00 2001 From: Magnus Hagdorn Date: Wed, 18 Dec 2024 16:56:38 +0100 Subject: [PATCH 03/13] emphasise that all parts of the institution are meant --- paper.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paper.tex b/paper.tex index c993870..bbbf98d 100644 --- a/paper.tex +++ b/paper.tex @@ -262,7 +262,7 @@ \section{Vision}% \subsection{Module 1: Foster a local Network of RSEs}% \label{sec:network} -One of the core responsibilities of an RSE unit is to act as a coordinator of RSE activities within the institution. +One of the core responsibilities of an RSE unit is to act as a coordinator of RSE activities across the institution. At virtually every academic institution there are employees that assume at least part-time the role of an RSE. These RSEs typically work isolated from similar RSEs in different groups, within the same institution. A central RSE unit provides a condensation core and connects RSEs in spokes with each other and with those at the hub. From cdf55b2800487bf7f95eb6eba9b5fed3b02e98c4 Mon Sep 17 00:00:00 2001 From: Magnus Hagdorn Date: Thu, 19 Dec 2024 12:41:30 +0100 Subject: [PATCH 04/13] reformulate module 1 --- paper.tex | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/paper.tex b/paper.tex index bbbf98d..5287fa0 100644 --- a/paper.tex +++ b/paper.tex @@ -263,24 +263,25 @@ \subsection{Module 1: Foster a local Network of RSEs}% \label{sec:network} One of the core responsibilities of an RSE unit is to act as a coordinator of RSE activities across the institution. -At virtually every academic institution there are employees that assume at least part-time the role of an RSE. +Research software is an integral part of modern research. +There are, therefore, researchers in every institution that at least sometimes perform the tasks of an RSE. These RSEs typically work isolated from similar RSEs in different groups, within the same institution. -A central RSE unit provides a condensation core and connects RSEs in spokes with each other and with those at the hub. +The central RSE unit together we the embedded RSEs form a hub and spokes network. -Connecting RSEs in spokes has multiple, positive effects, both for them as well as for the organisation. +Connecting embedded RSEs has multiple, positive effects, both for them as well as for the organisation: It will enable them to get to know others in similar situations and to learn from as well as support each other. -Contact with the central RSE unit will also help RSEs to professionalise their software-related work, which will directly benefit not only themselves but also their research groups. -In addition, the networking opportunities allow the distribution of knowledge about tools and resources within network partners, including the central RSE unit. -There are many RSE skills for which mastering can take many years; time that a part-time RSE usually can not spare. -A central RSE unit can make sure to connect RSEs in spokes to others with the relevant expertise or offer it themselves. -Fostering the network also enables the RSE unit to monitor institutional RSE activities, thereby providing the insight necessary to prevent duplication of work and support synergies. +Embedded RSEs can ask a central RSE unit for advice on specific problems. +They can also pass some tasks to the central RSE unit if they lack the knowledge or resources to solve those themselves. +Contact with the central RSE unit also help RSEs to professionalise their software-related work, which will directly benefit not only themselves but also their research groups. +Additionally, the networking opportunities allow the distribution of knowledge about tools and resources within the network. +Information also flows from the embedded RSEs to the central RSE unit allowing it to discover common requirements and opportunities to centralise some services. How an RSE unit realises this task will depend heavily on its environment and resources. -We only mention a few examples here to provide inspiration, with the explicit claim of incompleteness. -These include talks, seminars, workshops, meet-ups, hackathons, as well as informal regulars' tables. -As a foundation, a central RSE unit employs experienced RSEs, mostly at the post-doctoral level, who are not only expert software engineers, but also good communicators with the ability to work interdisciplinarily. +We only mention a few examples here to provide inspiration, with the explicit claim of incompleteness: +talks, seminars, workshops, hackathons, as well as informal meet-ups all facilitate establishing a local network of RSEs. +As a foundation, a central RSE unit employs experienced RSEs, mostly at the post-doctoral level, who are not only expert software engineers, but also good communicators with the ability to work in interdisciplinary teams. At least a core of a central RSE unit's employees need to have permanent contracts to be able to offer that deep expertise that requires years of experience. -Moreover, an onboarding process can serve as an entry point for new RSEs, whether in the hub or in spokes, into an institution's network. +Moreover, an onboarding process can serve as an entry point for new RSEs, whether in the central RSE unit or as an embedded RSE, into an institution's network. This gives an opportunity to gauge how the new colleague can benefit from the RSE unit's teaching services and whom they might want to network with based on their planned work. Similarly an off-boarding process can help to make sure that all acquired knowledge that is relevant to the institution is passed on to someone who stays, even if possibly not within the specific research group. From d956d17773941be6e113c754aa92b00db3ef6a9e Mon Sep 17 00:00:00 2001 From: Magnus Hagdorn Date: Thu, 19 Dec 2024 12:46:58 +0100 Subject: [PATCH 05/13] replace RSEs in spokes with embedded RSEs --- paper.tex | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/paper.tex b/paper.tex index 5287fa0..f2b2850 100644 --- a/paper.tex +++ b/paper.tex @@ -326,7 +326,7 @@ \subsection{Module 3: Development Services}% With the leverage of these projects being usually very high, realising as many of them as possible gives a great boost to the research institution. Many existing RSE units (\eg{} Manchester, Heidelberg) offer this type of small scale service free of charge and use it to promote their services within the institution. -For research projects requiring more substantial software development resources, an RSE unit could --- either through the hub or its spokes --- provide the required developer capacity. +For research projects requiring more substantial software development resources, an RSE unit could --- either through central or embedded RSEs --- provide the required developer capacity. This is especially relevant if the researchers hired for the research projects do not have the required software development skills and the volume of the development is too small to hire a dedicated developer. Depending on the scale of the involvement, the RSE unit can either be included into the grant proposal via a co-PI or as an internal service provider. @@ -337,7 +337,7 @@ \subsection{Module 3: Development Services}% This applies both to domain-specific research software (\eg{} simulation frameworks widely used throughout the institution) and to domain-agnostic software and data infrastructure (\eg{} Jupyter, workflow management systems, data repository software). -While all of the above development services can be flexibly performed either at the RSE hub or its spokes, there are advantages of having a hub in the process: +While all of the above development services can be flexibly performed either at the central RSE unit or by embedded RSEs, there are advantages of having a hub in the process: It allows building up highly specialised technical expertise with a long term perspective and reuse it across the entire institution. Examples of topics that would benefit from such expertise pooling are \eg{} mobile app development and UI/UX development. @@ -365,7 +365,7 @@ \subsection{Module 3: Development Services}% \subsection{Module 4: Teaching Services}% \label{sec:teaching} -A central RSE unit can provide or organise training for researchers and RSEs in spokes. +A central RSE unit can provide or organise training for researchers and embedded RSEs. This can replace self-education for foundational software development skills and provide a basis from which researchers can continue to learn more specialised skills guided by experts of the central RSE unit. It also improves the quality of much of the fairly simple software being written by researchers; scripts to process and maybe visualise their data\todo{magi: isn't that the whole point of teaching to get better at something no matter whether simple or not. I think we can drop this sentence}. Since teaching material for foundational software development skills is freely available, @@ -419,9 +419,9 @@ \subsection{Module 6: RSE Infrastructure Provisioning}% However, a central RSE unit can provide extra services by acting as an intermediary for RSE infrastructure and by hosting pilot instances of new tools and services. IT departments typically only provide the service for hosting and accessing IT infrastructures, such as RSE infrastructures\todo{magi: what is RSE infrastructure? database, web services, compute clouds?}. Central RSE units are a link between the central services offered either by IT departments, computing centres or over-archingly available services on one side, -and RSEs in spokes on the other, offering documentation, training and best-practices to efficiently and effectively use available services and comply with established processes. +and embedded RSEs on the other, offering documentation, training and best-practices to efficiently and effectively use available services and comply with established processes. -Furthermore, the central RSE unit can offer consulting for RSEs in spokes to guide selection processes of the tools and services best suited for each project. +Furthermore, the central RSE unit can offer consulting for embedded RSEs to guide selection processes of the tools and services best suited for each project. This holds for existing RSE, or more general IT, infrastructure. However, as scientists are working, by definition, at the cutting edge, they will often need or want to use the newest tools. When such a need is identified in the course of a consultation, a central RSE unit can set up and provide access to pilot instances to evaluate these tools. @@ -431,7 +431,7 @@ \subsection{Module 6: RSE Infrastructure Provisioning}% On the contrary, the RSE unit should act as a multiplier for the RSE-relevant services offered by the IT department, helping RSEs to discover and use existing and upcoming services. Similarly, the RSE unit can promote the use of the available computing infrastructure provided by a computing centre, helping with the support of the users when RSE-related questions in this context arise. Once the mutual collaboration between RSE unit, IT department and computing centre has been established, a stricter policy-based involvement of the RSE unit for infrastructure requests is envisioned. -Overall, by acting as an intermediary for RSE infrastructure related requests, the central RSE unit can augment the IT department and the computing centre, providing RSEs in spokes with the specific support they require. +Overall, by acting as an intermediary for RSE infrastructure related requests, the central RSE unit can augment the IT department and the computing centre, providing embedded RSEs with the specific support they require. \subsection{Module 7: Research Software Engineering Research}% \label{sec:rseresearch} From e6a07cd656eeb29803d81b38eb5cc1a2219ecf09 Mon Sep 17 00:00:00 2001 From: Magnus Hagdorn Date: Thu, 19 Dec 2024 12:50:28 +0100 Subject: [PATCH 06/13] link local embedded RSEs to global RSE community --- paper.tex | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/paper.tex b/paper.tex index f2b2850..6154196 100644 --- a/paper.tex +++ b/paper.tex @@ -469,7 +469,8 @@ \subsection{Module 9: RSE Outreach}% either directly from the RSE unit or by advertising at the institution and matchmaking with local RSEs interested in becoming active beyond their current tasks. The RSE unit thus contributes to the RSE communities on a regional, national or international level on the one hand and opens these up to the local RSEs and enables networking on the other hand. It organises the bidirectional exchange between the local and the global community and is the central hub for information coming both ways. -Furthermore, the RSE unit should advocate the use of RSE techniques and best-practices within their institutions actively to strengthen the local community and to reach out to new groups whenever possible\todo{magi: this could be strengthened by invoking the hub and spoke model again}. +Furthermore, the RSE unit should advocate the use of RSE techniques and best-practices within their institutions actively to strengthen the local community and to reach out to new groups whenever possible. +This also provides extra links for the local embedded RSEs to the global RSE community. \section{Existing Implementations} From 52fd7e676bf97ddb1753d2b0ff371c9ddce8ae89 Mon Sep 17 00:00:00 2001 From: Bernd Flemisch Date: Fri, 24 Jan 2025 12:12:05 +0100 Subject: [PATCH 07/13] fix wording --- paper.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paper.tex b/paper.tex index 8598fd5..8d31a1d 100644 --- a/paper.tex +++ b/paper.tex @@ -265,7 +265,7 @@ \subsection{Module 1: Foster a local Network of RSEs}% Research software is an integral part of modern research. There are, therefore, researchers in every institution that at least sometimes perform the tasks of an RSE. These RSEs typically work isolated from similar RSEs in different groups, within the same institution. -The central RSE unit together we the embedded RSEs form a hub and spokes network. +The central RSE unit together with the embedded RSEs form a hub and spokes network. Connecting embedded RSEs has multiple, positive effects, both for them as well as for the organisation: It will enable them to get to know others in similar situations and to learn from as well as support each other. From d284d782d1429c089123c457c44792077ee962ae Mon Sep 17 00:00:00 2001 From: Magnus Hagdorn Date: Fri, 7 Feb 2025 12:18:58 +0100 Subject: [PATCH 08/13] fix grammar Co-authored-by: Jan Linxweiler --- paper.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paper.tex b/paper.tex index 8d31a1d..67f43d4 100644 --- a/paper.tex +++ b/paper.tex @@ -271,7 +271,7 @@ \subsection{Module 1: Foster a local Network of RSEs}% It will enable them to get to know others in similar situations and to learn from as well as support each other. Embedded RSEs can ask a central RSE unit for advice on specific problems. They can also pass some tasks to the central RSE unit if they lack the knowledge or resources to solve those themselves. -Contact with the central RSE unit also help RSEs to professionalise their software-related work, which will directly benefit not only themselves but also their research groups. +Contact with the central RSE unit also helps RSEs to professionalise their software-related work, which will directly benefit not only themselves but also their research groups. Additionally, the networking opportunities allow the distribution of knowledge about tools and resources within the network. Information also flows from the embedded RSEs to the central RSE unit allowing it to discover common requirements and opportunities to centralise some services. From dd8c2bb6945832fa2581d9c086d1cf9a210ad99a Mon Sep 17 00:00:00 2001 From: Magnus Hagdorn Date: Fri, 7 Feb 2025 14:06:21 +0100 Subject: [PATCH 09/13] implicitly define what we mean with embedded RSEs --- paper.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paper.tex b/paper.tex index 67f43d4..323d4a0 100644 --- a/paper.tex +++ b/paper.tex @@ -264,7 +264,7 @@ \subsection{Module 1: Foster a local Network of RSEs}% One of the core responsibilities of an RSE unit is to act as a coordinator of RSE activities across the institution. Research software is an integral part of modern research. There are, therefore, researchers in every institution that at least sometimes perform the tasks of an RSE. -These RSEs typically work isolated from similar RSEs in different groups, within the same institution. +These embedded RSEs typically work isolated from similar RSEs in different groups, within the same institution. The central RSE unit together with the embedded RSEs form a hub and spokes network. Connecting embedded RSEs has multiple, positive effects, both for them as well as for the organisation: From d0d1c6094f0e9f58247f731f3fdab48856628b11 Mon Sep 17 00:00:00 2001 From: Dominic Kempf Date: Fri, 7 Feb 2025 14:27:49 +0100 Subject: [PATCH 10/13] Update paper.tex Co-authored-by: Jan Linxweiler --- paper.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paper.tex b/paper.tex index 323d4a0..975ffa5 100644 --- a/paper.tex +++ b/paper.tex @@ -263,7 +263,7 @@ \subsection{Module 1: Foster a local Network of RSEs}% One of the core responsibilities of an RSE unit is to act as a coordinator of RSE activities across the institution. Research software is an integral part of modern research. -There are, therefore, researchers in every institution that at least sometimes perform the tasks of an RSE. +There are, therefore, researchers in every institution that at least sometimes perform the tasks of an RSE. We call these RSEs embedded RSEs. These embedded RSEs typically work isolated from similar RSEs in different groups, within the same institution. The central RSE unit together with the embedded RSEs form a hub and spokes network. From 61f68f82a2fb3bd5ca9d1e2cb591a9c783ad7843 Mon Sep 17 00:00:00 2001 From: Magnus Hagdorn Date: Fri, 7 Feb 2025 14:33:02 +0100 Subject: [PATCH 11/13] specify dedicated and embedded RSEs --- paper.tex | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/paper.tex b/paper.tex index 975ffa5..28ba46d 100644 --- a/paper.tex +++ b/paper.tex @@ -73,7 +73,8 @@ \section{Introduction} \textbf{Research software engineers:}\\ People who create or improve research software and/or the structures that the software interacts with the computational ecosystem of a research domain. They are highly skilled team members who may also conduct their own research as part of their role. -However, we also recognise RSEs who have chosen to focus on a technical role as an alternative to a traditional research role.\\ +However, we also recognise RSEs who have chosen to focus on a technical role as an alternative to a traditional research role. +We call RSEs who are members of the RSE hub (see below) dedicated RSEs. RSEs who are members of a research group are called embedded RSEs.\\ \textbf{Researchers:}\\ RSEs might also be researchers. However, for the lack of a proper term and to avoid many “non-RSE researchers” within the text, we will refer by “researchers” to all non-RSEs involved in research or in research supporting organisations such as in \eg{} libraries, hence those that are at most sporadically performing RSE actions.\\ From b18992da6cb4a53d79d04fcad4a874dd8db68a65 Mon Sep 17 00:00:00 2001 From: Magnus Hagdorn Date: Fri, 7 Feb 2025 14:42:52 +0100 Subject: [PATCH 12/13] undo dd8c2bb --- paper.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paper.tex b/paper.tex index 28ba46d..3ac06db 100644 --- a/paper.tex +++ b/paper.tex @@ -265,7 +265,7 @@ \subsection{Module 1: Foster a local Network of RSEs}% One of the core responsibilities of an RSE unit is to act as a coordinator of RSE activities across the institution. Research software is an integral part of modern research. There are, therefore, researchers in every institution that at least sometimes perform the tasks of an RSE. We call these RSEs embedded RSEs. -These embedded RSEs typically work isolated from similar RSEs in different groups, within the same institution. +These RSEs typically work isolated from similar RSEs in different groups, within the same institution. The central RSE unit together with the embedded RSEs form a hub and spokes network. Connecting embedded RSEs has multiple, positive effects, both for them as well as for the organisation: From 57849d8fa165f881a25b398bfd2e3a4b3bb6f7e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frank=20L=C3=B6ffler?= Date: Thu, 13 Feb 2025 07:44:39 +0100 Subject: [PATCH 13/13] remove comma --- paper.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/paper.tex b/paper.tex index 38464cb..d8e726c 100644 --- a/paper.tex +++ b/paper.tex @@ -268,7 +268,7 @@ \subsection{Module 1: Foster a local Network of RSEs}% These RSEs typically work isolated from similar RSEs in different groups, within the same institution. The central RSE unit together with the embedded RSEs form a hub and spokes network. -Connecting embedded RSEs has multiple, positive effects, both for them as well as for the organisation: +Connecting embedded RSEs has multiple positive effects, both for them as well as for the organisation: It will enable them to get to know others in similar situations and to learn from as well as support each other. Embedded RSEs can ask a central RSE unit for advice on specific problems. They can also pass some tasks to the central RSE unit if they lack the knowledge or resources to solve those themselves.