S4 IMPRS-IS Workshop

This is the repository containing the material for the workshop Standards and Good Practices for Software Development in Python organized by the Software Workshop for the IMPRS-IS.

It will take place remotely on Thursday, October 28.

Before the workshop

Please make sure you have completed the following steps before the workshop:

• you have installed Python3 on your machine. We recommend a default system python installation over the Anaconda distribution;
• you have installed your favorite environment for writing code. We recommend using an Integrated Development Environment(IDE, e.g. VS Code, PyCharm, Eclipse, Atom...) but you can also use Emacs or vim if you are courageous enough;
• you have installed git on your machine;
• you have installed a git client in order to perform git operations. The most popular solutions are SourceTree (macOS/Win) and GitKraken (Linux/macOS/Win) but you can also use IDE plugins.
• you have successfully cloned this repository locally on your machine and you can perform some trivial operations (fetch, create a branch...);
• you are relaxed and in a happy mood!

Tentative program

• 9:00 - 9:10: Introduction (Sara)
• 9:10 - 10:45: The basics of git (Jean-Claude)
• 10:45 - 11:00: Break
• 11:00 - 12:00: Good practices for Python development (Ivan)
• 12:00 - 13:00: Lunch
• 13:00 - 14:00: Jupyter Notebooks (Ivan)
• 14:00 - 14:30: Profiling your code (Ivan)
• 14:30 - 14:45: Break
• 14:45 - 15:45: Testing and documenting your code (Jean-Claude)
• 15:45 - 16:00: Retrospective (Jean-Claude)