good-code-etiquette

“Programs must be written for people to read, and only incidentally for machines to execute.” ― Harold Abelson, Structure and Interpretation of Computer Programs

We will use peardeck for the presentation.

Go to joinpd.com and type in the code given you.

You will likely need to sign in with you google account.

Session 1: Interactive lecture, intro to coding style and practices

Examples explored:

• Readability
• Structure
• Documentation
• Exception
• [DRY examples](DRY examples.ipynb)
• Testing
• Vectorize

Session 2: Hands on project work, applying skills to (intentionally) crappy code

After installing conda, please do conda env create -f hwsa-environment.yml

Data

In this part of the workshop we will look at an example code to reproduce HR diagrams using Gaia data. We can query the Gaia public database and download the required data. However, the query run in the notebook takes a long time so the data is made available here:

Data can be found here:

In votable formaat

As a pkl file

vot table subset

Session 3: Revision and Benchmarking

• When and What to Optimise
• Timing Code Snippets
• Profiling Code
• Parallelising Code
• Advanced Track

Licence

ADACS Good Code Etiquette workshop by Paul Hancock, Rebecca Lange, Manodeep Sinha is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.