Summary and Schedule
Byte-sized RSE
Byte-sized RSE is a series of standalone mini training materials providing key research software skills in around 1-1.5 hour. It has been originally been developed and run by the UNIVERSE-HPC project. There have been 3 Byte-sized RSE series so far, each with a number of episodes - some of which are documented in this course:
- Integrated Development Environments
- Code Style & Linting
- Intermediate Git
- Code Review
- Unit Testing Code
Each episode is standalone - you can jump staight into the episode you are interested in and do not have to read preceeding episodes.
Target Audience
Research Software Engineers (RSEs), reseachers and postgraduates involved in computational research who already posses foundational computational skills and who are now:
- looking for quick refreshers, tips, or wanting to improve the sustainability or quality of their research code and are keen on continuous learning without heavy time investment.
- interested in advancing their skills and learning best practices for software in research.
- seeking digestible content to bridge the gap between research and software and benefiting from short-form RSE tips/tools to improve their research workflows.
Prerequisite
Episodes may require some prerequisite knowledge clearly described at the start or each episode, along with its own, individual, setup instructions.
Setup Instructions | Download files required for the lesson | |
Duration: 00h 00m | 1. Lesson 1: Integrated Development Environments |
What is an Integrated Development Environment (IDE)? Why use an IDE? What are common IDE features that code developers find extremely useful? What are some commonly used IDEs among the RSE community? |
Duration: 00h 15m | 2. 1.1 Setup & Prerequisites |
What prerequiste knowledge is required to follow this topic? How to setup your machine to follow this topic? |
Duration: 00h 27m | 3. 1.2 Getting Started with VSCode | FIXME |
Duration: 00h 37m | 4. 1.3 Using the Code Editor | FIXME |
Duration: 00h 47m | 5. 1.4 Running and Debugging Code | FIXME |
Duration: 00h 59m | 6. Lesson 2: Code Style & Linting | FIXME |
Duration: 01h 14m | 7. 2.1 Setup | FIXME |
Duration: 01h 26m | 8. 2.2 Some Example Code | FIXME |
Duration: 01h 36m | 9. 2.3 Analysing Code using a Linter | FIXME |
Duration: 01h 46m | 10. 2.4 Advanced Linting Features | FIXME |
Duration: 01h 56m | 11. Lesson 3: Intermediate Git | FIXME |
Duration: 02h 11m | 12. 3.1 Setup | FIXME |
Duration: 02h 23m | 13. 3.2 Some Example Code | FIXME |
Duration: 02h 33m | 14. 3.3 Feature Branch Workflow | FIXME |
Duration: 02h 43m | 15. 3.4 Creating a Pull Request | FIXME |
Duration: 02h 53m | 16. 3.5 Merging a Pull Request | FIXME |
Duration: 03h 03m | 17. 3.6 Merge Conflicts | FIXME |
Duration: 03h 13m | 18. Lesson 4: Code Review | FIXME |
Duration: 03h 28m | 19. 4.1 Setup | FIXME |
Duration: 03h 40m | 20. 4.2 Some Example Code | FIXME |
Duration: 03h 50m | 21. 4.3 Fixing a Repository Issue | FIXME |
Duration: 04h 00m | 22. 4.4 Submiting a Pull Request | FIXME |
Duration: 04h 10m | 23. 4.5 Reviewing a Pull Request | FIXME |
Duration: 04h 20m | 24. 4.6 Merge the Pull Request | FIXME |
Duration: 04h 30m | 25. Lesson 5: Unit Testing Code | FIXME |
Duration: 04h 45m | 26. 5.1 Setup | FIXME |
Duration: 04h 57m | 27. 5.2 Some Example Code | FIXME |
Duration: 05h 07m | 28. 5.3 Creating a New Test | FIXME |
Duration: 05h 17m | 29. 5.4 Handling Errors | FIXME |
Duration: 05h 27m | Finish |
The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.
Setup
Each episode is standlaone and has its own individual setup - there is no setup for the whole course.