From 86a8c6fa1c49868d3ef07965b9590e59fc7f96eb Mon Sep 17 00:00:00 2001 From: Carlos Martinez Date: Tue, 10 Jun 2025 12:25:58 +0200 Subject: [PATCH] Initial content suggestions --- _data/accordion.yml | 52 +++++++++++++++++++++++++++++++++++++++++---- _data/hero.yml | 2 +- _data/slider.yml | 35 ++++++++++++++++++------------ _data/toolkit.yml | 18 +++++++++------- 4 files changed, 80 insertions(+), 27 deletions(-) diff --git a/_data/accordion.yml b/_data/accordion.yml index d004bc6..d559ab6 100644 --- a/_data/accordion.yml +++ b/_data/accordion.yml @@ -8,19 +8,63 @@ items: icon: /assets/img/icons/guidance.svg subtitle: Guidance on sustainable software for the NES domain content: >- - A software management plan (SMP) aids in implementing best practices during software development and ensures the software remains accessible and reusable in both the short and longer term. It also contributes to the reproducibility of results and promotes collaborative work on open-source software for research. Moreover, an SMP encourages researchers to plan for the software’s long-term sustainability and community uptake of the software. + A software management plan (SMP) aids in implementing best practices during + software development and ensures the software remains accessible and reusable + in both the short and longer term. It also contributes to the reproducibility of + results and promotes collaborative work on open-source software for research. + Moreover, an SMP encourages researchers to plan for the software’s long-term + sustainability and community uptake of the software. + + + We created a the [SMP decision tree](#toolkit-smp-decision-tree) to guide + you through the process of creating an SMP. - title: Tools icon: /assets/img/icons/tools.svg subtitle: Tools to support sustainable software development content: >- - Text + Guidance for sustainable research development is crucial, but it is also important + to provide means to make it practical and applicable during the whole development + cycle. If such support is not readily available when the guidance is published, + uptake by the community might be significantly delayed. + + + In this project, we developed [research software templates](#toolkit-meta-template) + that implement the best practices recommended by the guidance and provide boilerplate + code and assets to initiate the research software development, including unit tests, + documentation, etc. This will allow the researchers to apply the guidance in a much + quicker and practical way by using different languages (e.g. Python, R). + - title: Integrating digital infrastructure for sustainable software icon: /assets/img/icons/integration.svg subtitle: Integrating digital infrastructure for sustainable software content: >- - Text + The use of digital infrastructure and services can contribute to enhancing software + sustainability, encompassing aspects such as version control, licensing, citation, + publication, and long-term preservation. We have integrated and improved existing + digital services relevant to the NES domain that support several aspects of software + sustainability. + + + The 4TU.ResearchData repository aids researchers of the science, engineering and + design disciplines with long-term archiving of software. 4TU.ResearchData is the + only certified repository in the Netherlands that provides support for sharing and + long-term preservation (at least 15 years) of both research data and software and for + disciplines from the entire NES domain. The Research Software Directory is a registry + developed by the eScience Center that enables both research performing organizations + and researchers to find, publish, cite, share, and measure the impact of research software. + + + We will write a blog summarising this integration. + - title: Learning resources icon: /assets/img/icons/resources.svg subtitle: Learning resources for sustainable software development content: >- - Text + We conducted a train-the-trainer workshops and walk-in sessions aimed at trainers, + training coordinators and researchers within the NES domain and at LDCCs. Through these + events we shared with participants our best practices for software + sustainability in the NES domain. + + + Based on these activities we created [training materials](#toolkit-ss-nes-lesson) which + can be used by the wider community. diff --git a/_data/hero.yml b/_data/hero.yml index d7cf21a..4112d89 100644 --- a/_data/hero.yml +++ b/_data/hero.yml @@ -1,7 +1,7 @@ # Hero section data title: Best Practices for Sustainable Software -subtitle: in Natural Science and Engineering +subtitle: in Natural Science and Engineering (SS-NES) text: >- Sustainable software practices (software management, software quality, FAIR software, and software preservation) are crucial for the reusability and long-term viability of diff --git a/_data/slider.yml b/_data/slider.yml index 4b306f0..e7f3a6c 100644 --- a/_data/slider.yml +++ b/_data/slider.yml @@ -1,24 +1,31 @@ # Slider section data -title: Why does software sustainability matter? -# subtitle: This is an optional subtitle +title: Software sustainability +subtitle: What is it and why does it matter? slides: - - title: Example of existing project with SS-NES implementation + - title: What is software sustainability? image_url: /assets/img/slider/slide-example-1.jpg image_alt: "Code shown on a computer screen in an office" content: >- - The SS-NES best practices are already being implemented in various projects, such as the NES project. - This project serves as a prime example of how these practices can be effectively applied in real-world scenarios. - - title: More about existing project with SS-NES implementation + In this project, we consider software sustainability as the collection of practices + used to ensure reusability and long-term viability of research software, + as well as its impact on research. + These practices encompass software management, software quality, FAIR software, and + software preservation. + - title: Why is software sustainability important? image_url: /assets/img/slider/slide-example-2.jpg image_alt: "Code on a computer screen" content: >- - Veniam, odio velit quis in exerci praesent nulla nibh at illum ea minim eum blandit vero - erat nostrud consectetuer et iusto amet, nisl feugiat ad aliquip wisi delenit consequat. - Euismod te sit tation diam ut dolor ut consequat, tincidunt lobortis zzril in hendrerit - nonummy accumsan elit, dolore dolore autem volutpat. augue adipiscing vel eu ipsum eros - qui facilisi. ullamcorper enim Duis esse feugait dolore suscipit et Lorem Ut facilisis sed - duis vulputate luptatum dolor nulla magna vel dignissim aliquam iriure commodo molestie ex laoreet. - - Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut. + Research software, encompassing scripts, code, tools, and digital methodologies, + is crucial to academic research, particularly in the Natural Sciences & Engineering + (NES) domain. Despite the importance of Research software, attention for software sustainability + often remains limited. + - title: The SS-NES project + image_url: /assets/img/slider/slide-example-2.jpg + image_alt: "Code on a computer screen" + content: >- + This project addressed several aspects of software sustainability + to actively support the research community within the NES domain. By providing + domain-relevant guidelines, tools, infrastructure, and training, the project + supported awareness and uptake of best practices during the entire software life cycle. diff --git a/_data/toolkit.yml b/_data/toolkit.yml index 2978c19..262b88d 100644 --- a/_data/toolkit.yml +++ b/_data/toolkit.yml @@ -8,24 +8,26 @@ items: icon: /assets/img/icons/tools/smp-decision-tree.svg summary: >- This is a questionnaire package for a Software Management Plan (SMP). - It is used with the docassemble framework: [https://docassemble.org](https://docassemble.org). + + This is an [open source](https://github.com/SS-NES/docassemble-SMPDecisionTree) tool. button: label: View tool - url: /#toolkit-smp-decision-tree + url: https://smp.research.software/ - title: SS-NES-lesson icon: /assets/img/icons/tools/ss-nes-lesson.svg summary: >- - Training material of the software sustainability of the TDCC NES project. + Training material of the software sustainability of the TDCC NES project. These materials are + also available on [GitHub](https://github.com/SS-NES/SS-NES-lesson). button: - label: View tool - url: /#toolkit-ss-nes-lesson + label: View training materials + url: https://ss-nes.github.io/SS-NES-lesson/ - title: Code-auditor icon: /assets/img/icons/tools/code-auditor.svg summary: >- A package and command-line utility to audit code quality and compliance to the best practices. button: label: View tool - url: /#toolkit-code-auditor + url: https://github.com/SS-NES/code-auditor - title: Meta-template icon: /assets/img/icons/tools/meta-template.svg summary: >- @@ -35,7 +37,7 @@ items: organisation to customize software templates to their needs. button: label: View tool - url: /#toolkit-meta-template + url: https://github.com/SS-NES/meta-template - title: python-template icon: /assets/img/icons/tools/python-template.svg summary: >- @@ -45,4 +47,4 @@ items: including unit tests, documentation, etc. button: label: View tool - url: /#toolkit-python-template + url: https://github.com/NLeSC/python-template/