Skip to content

Commit

Permalink
programme
Browse files Browse the repository at this point in the history
  • Loading branch information
@Romain-Thomas-Shef
Romain-Thomas-Shef committed Oct 14, 2024
1 parent a4af077 commit bea2561
Show file tree
Hide file tree
Showing 4 changed files with 503 additions and 49 deletions.
0 docs/assets/images/survey.png → docs/assets/images/Survey.png
View file
File renamed without changes
144 changes: 129 additions & 15 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -779,7 +779,7 @@ <h2>FA<span style="color:red">IR</span>4RS: Licence your code!</h2>
<section id="fair4rs-get-credit-for-your-work" class="slide level2 smaller">
<h2>FA<span style="color:red">IR</span>4RS: Get credit for your work</h2>
<p>If people are using your software you should get credit for it.</p>
<p><span class="emoji" data-emoji="arrow_right">➡️</span> state how you want to be credited. You can add it in the documentation and/or create a citation.cff file that you can add with your code.</p>
<p><span class="emoji" data-emoji="arrow_right">➡️</span> state how you want to be credited. You can add it in the documentation and/or create a <a href="https://citation-file-format.github.io/">citation.cff</a> file that you can add with your code (<a href="https://citation-file-format.github.io/cff-initializer-javascript/#/">tools</a>. are available to generate them)</p>

<img data-src="assets/images/credit.png" class="r-stretch"></section>
<section id="fair4rs-share-it" class="slide level2 smaller">
Expand Down Expand Up @@ -859,7 +859,7 @@ <h2>Lack of skills for developing software</h2>
<div class="column" style="width:50%;">
<p><br><br> Do you feel that you have received sufficient training to develop reliable software? <br> <font size="3">Bob Turner &amp; Paul Richmond, UoS, RSE team, <a href="rse.shef.ac.uk/sssurvey">github.com/RSE-Sheffield/sssurvey</a>. </font></p>
</div><div class="column" style="width:50%;">
<p><img data-src="assets/images/survey.png" class="absolute" style="top: 200px; left: 600px; width: 400px; height: 200px; "></p>
<p><img data-src="assets/images/Survey.png" class="absolute" style="top: 200px; left: 600px; width: 400px; height: 200px; "></p>
</div></div>
</section>
<section id="the-fair24rs-programme-overview" class="slide level2">
Expand All @@ -868,30 +868,142 @@ <h2>The FAIR<sup>2</sup>4RS Programme: Overview</h2>
<img data-src="assets/images/Programme.png" class="quarto-figure quarto-figure-center r-stretch"></section>
<section id="software-lifecycle-planning" class="slide level2">
<h2>Software Lifecycle Planning</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><br><br> <span style="color:red">Who</span>: <a href="mailto:romain.thomas@sheffield.ac.uk">Romain Thomas</a>, <a href="">R. Campbell</a>, <a href="">K. O’Neill</a></p>
<p><span style="color:red">When/Length</span>: November 8th / 2.5h (afternoon)</p>
<p><span style="color:red">Format</span>: Online</p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p><br> <ins>Abstract:</ins><br>
When you start writing software it is often very useful to think about the development process and how you will make your software sustainable in the long term. In this module we will introduce important aspects of software development in research: <span style="color:red"><em>software management plan, licences and dissemination</em></span>. This module should allow you to ask yourself the right questions when starting a research software project.</p>
</font><p><font size="5"></font></p>
</div></div>
</section>
<section id="version-control-git-github-and-gitkraken---from-zero-to-hero" class="slide level2">
<h2>Version control: Git, GitHub and GitKraken - From Zero to Hero</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><br><br> <span style="color:red">Who</span>: <a href="mailto:neil.shephard@sheffield.ac.uk">Neil Shephard</a></p>
<p><span style="color:red">When/Length</span>: 18/19 November (2 half days). Another session in February</p>
<p><span style="color:red">Format</span>: In person</p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p><br> <ins>Abstract:</ins> If you’ve never heard of or used version control and Git before this is the course for you. We start by introducing version control and exploring how it can be beneficial to researchers, then we introduce some useful tools and get started with some basic workflow using these tools. We build on those foundations with collaborative exercises that introduce key concepts such as forks, pull requests and branches and give you the chance to <span style="color:red"><em>get some hands-on experience with using version control in a research setting</em></span>.</p>
</font><p><font size="5"></font></p>
</div></div>
</section>
<section id="version-control" class="slide level2">
<h2>Version control</h2>
<section id="advanced-version-control-git-collaboration" class="slide level2">
<h2>[Advanced] Version control: Git collaboration</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><br><br><br> <span style="color:red">Who</span>: <a href="mailto:neil.shephard@sheffield.ac.uk">Neil Shephard</a></p>
<p><span style="color:red">When/Length</span>: February</p>
<p><span style="color:red">Format</span>: In person</p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p><br> <ins>Abstract:</ins><br>
This course aims to help you develop a <span style="color:red"><em>deeper understanding of how Git works to facilitate collaboration</em></span>. It builds on foundations laid by the Git beginners course. The core idea around the course is that by improving your understanding of working with branches and how to make your commits tidier and neater it makes it easier 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!).</p>
</font><p><font size="5"></font></p>
</div></div>
</section>
<section id="code-design" class="slide level2">
<h2>Code Design</h2>
<section id="design-your-code-and-write-less-of-it" class="slide level2">
<h2>Design your code (and write less of it)</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><br><br><br> <span style="color:red">Who</span>: <a href="mailto:romain.thomas@sheffield.ac.uk">R. Thomas</a></p>
<p><span style="color:red">When/Length</span>: 12/13 December (2 half days)</p>
<p><span style="color:red">Format</span>: In person</p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p><br> <ins>Abstract:</ins></p>
<p>The way you write your code will have a massive impact on how easy it is to maintain in the long run. <span style="color:red"><em>This course on Code Design introduces essential principles and best practices for writing clean and maintainable code</em></span>. We will learn how we can write clean code, adhering to naming conventions, commenting, and following PEP 8 guidelines. We will then explore some fundamental principles such as DRY, KISS or YAGNI that are important to keep in mind when writing new code and see how we can spend less time touching the code by introducing configuration files and command line interface.</p>
</font><p><font size="5"></font></p>
</div></div>
</section>
<section id="code-testing" class="slide level2">
<h2>Code Testing</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><br><br><br> <span style="color:red">Who</span>: <a href="mailto:sylvia.whittle@sheffield.ac.uk">Sylvia Whittle</a></p>
<p><span style="color:red">When/Length</span>: January (half day)</p>
<p><span style="color:red">Format</span>: In person</p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p><br> <ins>Abstract:</ins></p>
<p>Does your code work? Are you sure? How do you ensure that it keeps working when you change it? Manually verifying is slow and tedious. Why not automate it? Software testing checks that your code works for you, and when it breaks, it can show you exactly where it broke, without you having to trawl through hundreds of lines of code manually.<span style="color:red"><em>This course aims to provide you with the tools you need to start automatically ensuring the reliability of your code.</em></span></p>
</font><p><font size="5"></font></p>
</div></div>
</section>
<section id="documentation" class="slide level2">
<h2>Documentation</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><br><br><br> <span style="color:red">Who</span>: <a href="mailto:joe.heffer@sheffield.ac.uk">Joe Heffer</a></p>
<p><span style="color:red">When/Length</span>: February (half day)</p>
<p><span style="color:red">Format</span>: In person</p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p><br> <ins>Abstract:</ins></p>
<p>Well-documented software promotes reproducibility, maintainability, and increased research impact through wider adoption and citation. <span style="color:red"><em>This course teaches researchers how to document their software effectively, making it accessible and understandable to others.</em></span> It covers topics such as writing readable code and usage instructions.</p>
</font><p><font size="5"></font></p>
</div></div>
</section>
<section id="reproducible-environments" class="slide level2">
<h2>Reproducible Environments</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><br><br> <span style="color:red">Who</span>: <a href="mailto:dan.brady@sheffield.ac.uk">Dan Brady</a></p>
<p><span style="color:red">When/Length</span>: March [half day]</p>
<p><span style="color:red">Format</span>: In person</p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p><br> <ins>Abstract:</ins></p>
<p>Ensuring that others are able to take your code, run it, and are able to produce the same (or equivalent) results is one of the key tenets of FAIR and reproducible research software. <span style="color:red"><em>This course will provide you with an overview of different ways to make your code reproducible</em></span> and then focus on virtual environments as a specific tool for computational reproducibility.</p>
</font><p><font size="5"></font></p>
</div></div>
</section>
<section id="packaging" class="slide level2">
<h2>Packaging</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><br><br> <span style="color:red">Who</span>: <a href="">Chris Wild</a> and <a href="">Farhad Allian</a></p>
<p><span style="color:red">When/Length</span>: April [half day]</p>
<p><span style="color:red">Format</span>: In person</p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p><br> <ins>Abstract:</ins></p>
<p>Packaging your software is one of the most important steps in a software project to make it both findable and accessible. <span style="color:red"><em>This course will provide you with an understanding of why and when packaging is useful</em></span>, what different standards exist to package Python projects and take you through each step of the packaging process.</p>
</font><p><font size="5"></font></p>
</div></div>
</section>
<section id="software-papers" class="slide level2">
<h2>Software Papers</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><br><br><br> <span style="color:red">Who</span>: <a href="mailto:romain.thomas@sheffield.ac.uk">Romain Thomas</a> &amp; <a href="">Arfon Smith</a></p>
<p><span style="color:red">When/Length</span>: April, 1.5h</p>
<p><span style="color:red">Format</span>: Online</p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p><br> <ins>Abstract:</ins></p>
<p>Did you know that you can actually publish a paper about your software? This is an ideal way to get recognition (and citation) for the software you have spent countless hours creating. <span style="color:red"><em>In this course we will walk you through an example of submission in the Journal of open Source software.</em></span> We will make an example software submission to the journal, and thanks to the collaboration of the Editor in Chief of JOSS (Arfon Smith), we will look at how the review process is done.</p>
</font><p><font size="5"></font></p>
</div></div>
</section>
<section id="end-to-end-demo" class="slide level2">
<h2>End-to-End demo</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><br><br> <span style="color:red">Who</span>: <a href="mailto:romain.thomas@sheffield.ac.uk">Romain Thomas</a></p>
<p><span style="color:red">When/Length</span>: April, 1.5h</p>
<p><span style="color:red">Format</span>: Online</p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p><br> <ins>Abstract:</ins></p>
<p>On a short demonstration, we will attempt to review the main points of the training program, from code design and version control, to testing, documentation and packaging of a short demo software.</p>
</font><p><font size="5"></font></p>
</div></div>
</section>
<section id="the-fair24rs-programme-timeline" class="slide level2">
<h2>The FAIR<sup>2</sup>4RS Programme: Timeline</h2>
Expand All @@ -904,7 +1016,7 @@ <h2>The FAIR<sup>2</sup>4RS Programme: Material and dependencies</h2>
<p><font size="5"></font></p><font size="5">
<ul>
<li><p>All materials are designed using the same structure (<a href="https://carpentries.github.io/workbench/">Software Carpentry workbench</a>) and are freely accessible on Github.</p></li>
<li><p><span style="color:red"><strong>You can select what lectures</strong></span> you will follow based on the skills you already have. Each lecture comes with a set of prerequisities that are clearly identified.</p></li>
<li><p><span style="color:red"><strong>You can pick-and-choose the lecture</strong></span> you will follow based on the skills you already have. Each lecture comes with a set of prerequisities that are clearly identified.</p></li>
<li><p>A feedback form will be provided after each lecture for feedback.</p></li>
</ul>
</font><p><font size="5"></font></p>
Expand All @@ -913,7 +1025,7 @@ <h2>The FAIR<sup>2</sup>4RS Programme: Material and dependencies</h2>
</div></div>
</section>
<section id="the-fair24rs-programme-important-notes" class="slide level2">
<h2>The FAIR<sup>2</sup>4RS Programme: Important Notes</h2>
<h2>the fair<sup>2</sup>4rs programme: important notes</h2>
<div class="columns">
<div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
Expand All @@ -923,18 +1035,20 @@ <h2>The FAIR<sup>2</sup>4RS Programme: Important Notes</h2>
<li>BUT! they all need registration and <span style="color:red">in-person sessions have limited places!</span></li>
<li>They will all be available on mydevelopment platform. The first 3 sessions are already open for registration:
<ul>
<li><a href="">Software Management plan</a> - Nov 8th</li>
<li><a href="">Git/Github zero to Hero</a> - Nov 18th/19th</li>
<li><a href="">Code Design</a> - Dec 12th/13th</li>
<li><a href="https://mydevelopment.csod.com/ui/lms-learning-details/app/event/2d69f5c5-f9e7-46c2-999a-ffb3ed1db028">Software Management plan</a> - Nov 8th</li>
<li><a href="https://mydevelopment.csod.com/ui/lms-learning-details/app/event/d4d09f67-097b-4451-8ddb-86cb90636c06">Git/Github zero to Hero</a> - Nov 18th/19th</li>
<li><a href="https://mydevelopment.csod.com/ui/lms-learning-details/app/event/d3c2cca5-d894-44b6-a79b-e93dea7a7c94">Code Design</a> - Dec 12th/13th</li>
</ul></li>
<li>January onward sessions will be available for booking around December.</li>
</ul>
</font><p><font size="5"></font></p>
</div><div class="column" style="width:50%;">
<p><font size="5"></font></p><font size="5">
<p>Direct links are also available on the RSE website: <br><br><br><br><br><br><br><br></p>
<p><img data-src="assets/images/FAIR_rse_website.png" class="absolute" style="top: 280px; left: 650px; width: 200px; height: 200px; "></p>
<p>Contacts:</p>
<ul>
<li>Direct links are also available on the RSE website: <br><br><br><br><br><br><br><br></li>
</ul>
<p><img data-src="assets/images/FAIR_rse_website.png" class="absolute" style="top: 240px; left: 650px; width: 200px; height: 200px; "></p>
<p><strong>Contacts:</strong></p>
<ul>
<li>Tamora James -RSE and FAIR<sup>2</sup>4RS Programme Manager -<a href="mailto:t.d.james@sheffield.ac.uk">(t.d.james@sheffield.ac.uk)</a></li>
<li>Romain Thomas -Head of RSE-<a href="mailto:romain.thomas@sheffield.ac.uk">(romain.thomas@sheffield.ac.uk)</a> - Head of RSE -</li>
Expand All @@ -948,7 +1062,7 @@ <h2>Acknowledgements &amp; References</h2>
<li>Thank you to Tamora James for leading the development of this training programme</li>
<li>Thank you to Christopher Wild, Ric Campbell, Farhad Allian, Daniel Brady, Kate O’neill, Joe Heffer, Jenni Adams, Neil Shephard, Sylvia Wittle and Arfon Smith for dedicating time to prepare all the material!</li>
</ul>
<p><strong>References</strong><br> * D. Wilby <a href="https://www.davidwilby.dev/opensourcefair4rs/#/title-slide">Lunchbyte talk on the FAIR principles</a><br> * T. James, FAIR for research software, Talk OpenFest 2024<br> * <a href="https://book.the-turing-way.org/index.html">https://book.the-turing-way.org/index.html</a><br> * B. Sirvey <a href="https://medium.com/@borissirbey/le-grand-homme-qui-apprend-0bc4f4330d2d">Le grand homme qui apprend</a><br> * Chue Hong, Neil P. et al, <a href="https://doi.org/10.15497/RDA00068">FAIR principles for Research Software</a><br></p>
<p><strong>References</strong><br> * D. Wilby <a href="https://www.davidwilby.dev/opensourcefair4rs/#/title-slide">Lunchbyte talk on the FAIR principles</a><br> * T. James, FAIR for research software, Talk OpenFest 2024<br> * <a href="https://book.the-turing-way.org/index.html">The Turing Way</a><br> * B. Sirvey <a href="https://medium.com/@borissirbey/le-grand-homme-qui-apprend-0bc4f4330d2d">Le grand homme qui apprend</a><br> * Chue Hong, Neil P. et al, <a href="https://doi.org/10.15497/RDA00068">FAIR principles for Research Software</a><br></p>
</section>
<section id="thank-you" class="slide level2">
<h2>Thank you!</h2>
Expand Down
Loading

0 comments on commit bea2561

Please sign in to comment.