Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reorganise FAIR2RS landing page #817

Merged
merged 3 commits into from
Sep 18, 2024
Merged

Reorganise FAIR2RS landing page #817

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5115d4
Reorganise FAIR2RS landing page
tdjames1 Sep 17, 2024
ad9ef1a
Apply suggestions from code review
tdjames1 Sep 18, 2024
519ee6e
FAIR2RS: Change course title to match TOC/internal link
tdjames1 Sep 18, 2024
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
88 changes: 40 additions & 48 deletions pages/training/fair4rs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,23 @@ type: text
permalink: /training/fair4rs/
---

## Introduction and target audience

## What are the FAIR principles for research software?
This training offers a modular programme to support researchers in applying FAIR (Findable, Accessible, Interoperable,
tdjames1 marked this conversation as resolved.
Show resolved Hide resolved
Reusable) principles and open research practices to their research software. The overview module provides an
introduction to [FAIR for research software](#what-are-the-fair-principles-for-research-software) and gives an overview
of the topics that are offered in more detail in [additional modules](#outline-of-the-programme), which can be selected
according to an individual’s learning goals.

The FAIR principles were originally developed as guidelines to enhance the reusability of research data. The FAIR
principles apply the concepts of Findability, Accessibility, Interoperability and Reusability to scholarly data
holdings, and were also intended to be applied to other digital research objects such as algorithms and workflows[^1].
This programme is aimed at researchers, including PhDs and postgraduate research students, who create code (whether a few
Copy link
Member

@Robadob Robadob Sep 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

including PhDs and postgraduate research students

I've always considered these to be equivalent, I wasn't aware the university offered MRes as an option (other than if you drop out of your PhD at 12 months). As a minimum PhDs are postgraduate research students.

Perhaps reword to research staff and students?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kind of prefer the version as it is.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did an MRes at this university!

scripts or something more substantial) as part of their research and who want to make their research more open by
applying the FAIR principles to their software.
tdjames1 marked this conversation as resolved.
Show resolved Hide resolved

### What are the FAIR principles for research software?

The FAIR principles were developed as guidelines to enhance the reusability of research data[^1]. The FAIR principles
apply the concepts of Findability, Accessibility, Interoperability and Reusability to scholarly data holdings, and were
also intended to be applied to other digital research objects such as algorithms and workflows.

Over the past few years there has been growing recognition that research software, defined as _“source code files,
algorithms, scripts, computational workflows and executables that were created during the research process or for a
Expand All @@ -19,42 +30,7 @@ reproducibility and open access. A modified set of FAIR principles for research
inherent differences between data and software, has been developed to provide a framework for the development of FAIR
research software[^3].

## FAIR<sup>2</sup> for research software

### Introduction and target audience

This training offers a modular programme to support researchers in applying FAIR principles and open research practices to
their research software. The overview module provides an introduction to FAIR for research software and gives an
overview of the topics that are offered in more detail in additional modules, which can be selected according to an
individual’s learning goals.

This programme is aimed at researchers, including PhDs and postgraduate research students, who create code (whether a few
scripts or something more substantial) as part of their research and who want to make their research more open by
applying the FAIR principles to their software.


### Learning outcomes


After completing this modular programme, participants should be able to:

- Understand the FAIR principles and describe how they apply to research software
- Explain how applying FAIR principles to research software can support open research goals such as transparency,
reproducibility and reusability
- Identify actions that can be taken at different stages of the research lifecycle to enhance the FAIRness of their
research software outputs
- Develop a plan addressing the intended scope, impact and lifespan of their research software
- Describe different types of software licence and discuss their potential implications for reuse of research software,
including commercialisation
- Apply best practices for scientific software development including design, version control, testing, continuous
integration and documentation
- Associate their research software with a unique and persistent identifier and use metadata to enhance its findability,
accessibility and reusability
- Identify repositories that provide long-term persistent storage for research software
- Apply approaches such as packaging and containers to enhance the reusability and reproducibility of research software.


### Outline of the programme
## Outline of the programme

<div class="alert alert-info"> <strong>Info!</strong> The definitive programme (with dates and registration links) will be
online on Oct 1st.</div>
Expand All @@ -67,7 +43,7 @@ online on Oct 1st.</div>
* [Software design](#software-design)
* [Testing and Continuous Integration](#testing-and-continuous-integration)
* [Documentation](#documentation)
* [Reproducible computational environment](#reproducible-computational-environments)
* [Reproducible computational environments](#reproducible-computational-environments)
* [Packaging](#packaging)
* [Publishing a software paper in JOSS](#publishing-a-software-paper-in-joss)

Expand All @@ -87,7 +63,6 @@ software sustainable in the long term. In this module we will introduce importan
research: software lifecyle, management plan, licences and dissemination. This module should allow you to ask yourself
the right questions when starting a research software project.


#### Version control

<!-- ##### Neil Shephard -->
Expand All @@ -106,7 +81,6 @@ improving your understanding of working with branches and how to make your commi
to understand pull requests and Git history which in turn makes it easier to collaborate and work on code with others
(including your future self!).


#### Software design
<!-- (Romain Thomas) -->

Expand All @@ -115,7 +89,6 @@ how to create maintainable, readable and reusable code. Using examples and exerc
creating high quality code is actually quite straightforward when you understand how to do it and what tools are available
to make your life easier.


#### Testing & Continuous Integration

<!-- (Sylvia Whittle) -->
Expand Down Expand Up @@ -162,14 +135,33 @@ review process is done.

<!-- Summary session (Romain Thomas) -->

### Prerequisites
## Prerequisites

Each session will have some individual prerequisites. Some experience with developing research software or scripts, for
example in Python or R, might be needed. Please refer to the individual course details to know what they are.

## Learning outcomes

Each session will have some individual prerequisities. Some experience with developing research software or scripts, for
example in Python or R might be needed. Please refer to the complete programme to know what they are.
After completing this modular programme, participants should be able to:

- Understand the FAIR principles and describe how they apply to research software
- Explain how applying FAIR principles to research software can support open research goals such as transparency,
reproducibility and reusability
- Identify actions that can be taken at different stages of the research lifecycle to enhance the FAIRness of their
research software outputs
- Develop a plan addressing the intended scope, impact and lifespan of their research software
- Describe different types of software licence and discuss their potential implications for reuse of research software,
including commercialisation
- Apply best practices for scientific software development including design, version control, testing, continuous
integration and documentation
- Associate their research software with a unique and persistent identifier and use metadata to enhance its findability,
accessibility and reusability
- Identify repositories that provide long-term persistent storage for research software
- Apply approaches such as packaging and containers to enhance the reusability and reproducibility of research software.

<!-- {% include events_list_upcoming.html category="fair4rs" %} -->

### Contact information
## Contact information
For enquiries, please contact Tamora James ([[email protected]](mailto:[email protected]), Programme
manager), and/or Romain Thomas, ([[email protected]](mailto:[email protected]), Head of the RSE
group).
Expand Down