Welcome#
Hello everyone and welcome to the Clean, tested and reusable Code workshop at the Kamitani Lab!
Within these pages, we provide information on how to follow the workshop, as well as respective materials. This jupyter book will include the used slides and code in a way that they can be explored in an interactive manner. You can navigate through the respective sections via the TOC on the left side and within sections via the TOC on the right side. The three symbols in the top allow to enable full screen mode, link to the underlying github repository and allow you to download the contents as a pdf or jupyter notebook respectively. All of this awesomeness (talking about the infrastructure and resource) is possible through the dedicated and second to none work of the Jupyter community, specifically, the Executable/Jupyter Book and mybinder project.
The workshop#
Overview
What’s this workshop about?
Course setup
Getting ready for the course.
Code formatting
How should code be formatted to ensure readability and intelligibility?
Code testing
How should code be tested to ensure functionality?
Continuous Integration
How should code testing and development be automated?
I’ve got a question!#
In case you have any questions or difficulties going through the workshop, please don’t hesitate a single second to get in touch with us. A great way to do this is to open an issue on the github site of the Workshop (also possible via the github button at the top of the pages). We would also highly appreciate and value every feedback or idea or you might have (via issues or hypothes.is annotation feature on the right).
Acknowledgements#
This workshop was organized by Yoshihiro Nagano and prepared/conducted by Peer Herholz based on materials from Peer Herholz and Julia Pfarr.