Summary and Schedule
This is a new lesson built with The Carpentries Workbench.
| Setup Instructions | Download files required for the lesson | |
| Duration: 00h 00m | 1. Modular Code Development |
What are the benefits of writing modular code in terms of maintenance
and scalability? How can nested code be targeted and improved through modularization? |
| Duration: 01h 00m | 2. Document your research software |
What can I do to make my code more easily understandable? What information should go into comments? What are docstrings and what information should go into docstrings? |
| Duration: 01h 55m | 3. Testing |
Why should I write automated tests for my code? How do I write a good unit test? |
| Duration: 02h 55m | 4. Continuous Integration | How can we implement automatic testing each time we push changes to the repository? |
| Duration: 04h 10m | Finish |
The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.
FIXME: Setup instructions live in this document. Please specify the tools and the data sets the Learner needs to have installed.
Data Sets
Download the data zip file and unzip it to your Desktop
Software Setup
Details
Setup for different systems can be presented in dropdown menus via a
spoiler tag. They will join to this discussion block, so
you can give a general overview of the software used in this lesson here
and fill out the individual operating systems (and potentially add more,
e.g. online setup) in the solutions blocks.
Use PuTTY
Use Terminal.app
Use Terminal