Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 37 additions & 31 deletions _data/accordion.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,63 +8,69 @@ 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
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

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: >-
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.
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, so that uptake by the community is not delayed.


In this project, we developed [Code Auditor](#toolkit-code-auditor), a tool
designed to audit research software for compliance with best practices. The tool
can automatically extract metadata from a codebase, identify issues such as missing
or conflicting practices, and provide suggestions for improvement. It also enables
comparison of the current state of the software against a reference, such as a SMP.


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).
We also developed [Meta Template](#toolkit-meta-template), a modern framework for
creating research software templates aligned with best practices. It offers
standardized, easily upgradable building blocks that support the creation and
maintenance of research software templates in various programming 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: >-
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
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
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.
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: >-
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
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
Based on these activities we created [training materials](#toolkit-ss-nes-lesson) which
can be used by the wider community.
4 changes: 2 additions & 2 deletions _data/footer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ links1:
url: /#tools/smp-decision-tree
- label: SS-NES-lesson
url: /#tools/ss-nes-lesson
- label: Code-auditor
- label: Code Auditor
url: /#tools/code-auditor
- label: Meta-template
- label: Meta Template
url: /#tools/meta-template
- label: python-template
url: /#tools/python-template
Expand Down
15 changes: 7 additions & 8 deletions _data/toolkit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,24 @@ items:
- 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. These materials are
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 training materials
url: https://ss-nes.github.io/SS-NES-lesson/
- title: Code-auditor
- 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.
A package and command-line utility to audit code quality and compliance to the research
software development best practices.
button:
label: View tool
url: https://github.com/SS-NES/code-auditor
- title: Meta-template
- title: Meta Template
icon: /assets/img/icons/tools/meta-template.svg
summary: >-
A toolkit to start software templates for research software and adopt best practices
on sustainable software for Natural and Engineering Sciences. It provides a way to align
best practices and reduce maintainance efforts across organisations, while allowing
organisation to customize software templates to their needs.
A framework to initiate and maintain tailored research software templates that align with best
practices and reduce maintainance efforts across organisations.
button:
label: View tool
url: https://github.com/SS-NES/meta-template
Expand Down
Loading