Add FAIR4RS training page #804
Conversation
Update FAIR2 course details
pages/training/fair4rs/index.md
Outdated
| single human that would not forget what they have done before. But what if one generation of researcher stops sharing | ||
| how they are doing their work? Research will stall. It is therefore the duty of each generation of researchers, to allow | ||
| the next one to take over in the most efficient way possible. In the age of digital research data-driven discovery, | ||
| sharing research can not be limited to publishing results on academic papers only. This is role of the Open Science |
There was a problem hiding this comment.
| sharing research can not be limited to publishing results on academic papers only. This is role of the Open Science | |
| sharing research can not be limited to publishing results in academic papers only. This is role of the Open Science |
There was a problem hiding this comment.
This suggestion got missed because @ns-rse made a suggestion in the same line.
| ### Outline of the program | ||
|
|
||
| <div class="alert alert-info"> <strong>Info!</strong> The definitive program (with dates and registration links) will be | ||
| online on Oct 1st.</div> |
There was a problem hiding this comment.
Maybe worth summarising the form the different events will take, I was surprised first was a lunchbytes seminar, I had assumed all were more carpentries-ey.
pages/training/fair4rs/index.md
Outdated
| #### Software design | ||
| <!-- (Romain Thomas) --> | ||
|
|
||
| The way you write your code will have a massive impact on how easy it is to maintain. During this course we will try to |
There was a problem hiding this comment.
During this course we will try to understand how to create maintainable, readable and reusable code.
we will try to understand
Doesn't really read right/make sense
|
|
||
| <!-- (Sylvia Whittle) --> | ||
|
|
||
| This course aims to equip researchers with the skills to write effective tests and ensure the quality and reliability of |
There was a problem hiding this comment.
I'd probably mention the fact it's unit testing by name, incase someone has specifically been told unit testing.
pages/training/fair4rs/index.md
Outdated
|
|
||
| [^1]: Wilkinson et al., ‘The FAIR Guiding Principles for Scientific Data Management and Stewardship’. | ||
| [^2]: Barker et al., ‘Introducing the FAIR Principles for Research Software’. | ||
| [^3]: Barker et al., ‘Introducing the FAIR Principles for Research Software’. |
There was a problem hiding this comment.
Same reference twice, could merge.
pages/training/fair4rs/index.md
Outdated
| 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 course is aimed at researchers, including PhDs and postgraduate research students, who create code (whether a few |
There was a problem hiding this comment.
| This course is aimed at researchers, including PhDs and postgraduate research students, who create code (whether a few | |
| This course is aimed at all researchers, including PhDs and postgraduate research students, research assistants, associate and professors, who create code (whether a few |
Perhaps overkill being so explicit. 🤔
There was a problem hiding this comment.
from PhDs to professors would do the same job.
| testing using Python's Pytest framework, a powerful and beginner-friendly tool. You'll also learn how to integrate | ||
| automated testing into your development workflow using continuous integration (CI). CI streamlines your process by | ||
| automatically running tests with every code change, catching bugs early and saving you time. | ||
|
|
There was a problem hiding this comment.
markdownlint-cli2 would I think complain about double line space here (there is a PR out #701 to integrate it into this repository but its been lingering for some time and not sure if it will be merged).
Co-authored-by: Neil Shephard <[email protected]>
Co-authored-by: Neil Shephard <[email protected]>
Co-authored-by: Robert Chisholm <[email protected]> Co-authored-by: Neil Shephard <[email protected]>
Co-authored-by: Robert Chisholm <[email protected]>
Co-authored-by: Robert Chisholm <[email protected]>
|
Thanks for the suggestions @Robadob and @ns-rse. Committed or commented on most of them. @Robadob there was one line where you had made two valid suggestions but it didn't let me commit both, so might need to re-suggest. There are several program -> programme substitutions still to do but I can't commit while pending review! |
If this is the 'a la carte' one, it was intended as an either/or, not both. Otherwise lmk what I need to fix. |
| 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, |
There was a problem hiding this comment.
Not going to add since would then have to gloss the acronym.
pages/training/fair4rs/index.md
Outdated
| single human that would not forget what they have done before. But what if one generation of researcher stops sharing | ||
| how they are doing their work? Research will stall. It is therefore the duty of each generation of researchers, to allow | ||
| the next one to take over in the most efficient way possible. In the age of digital research data-driven discovery, | ||
| sharing research can not be limited to publishing results on academic papers only. This is role of the Open Science |
There was a problem hiding this comment.
This suggestion got missed because @ns-rse made a suggestion in the same line.
pages/training/fair4rs/index.md
Outdated
| modern research. In the RSE team, we are ideally placed to witness that software is used in all research domains, from | ||
| physical sciences, to psychology or humanities. Some of these software tools are used to collect data from medical | ||
| patients, others are used to run complex simulations of merging galaxies. Software is an inherent part of research and | ||
| allows researchers to push boundaries of what still was impossible few years ago. Software often holds the key to the |
There was a problem hiding this comment.
This suggestion got missed because of your other suggestion on the same line.
program -> programme
|
Already approved by me, or did you want me to read through it a second time? |
New page containing course description and preliminary details for FAIR4RS training course.