Astronomical Data Analysis Software & Systems XXXIV

User facing tutorials as code: reproducible and reliable tutorials with CI/CD
2024-11-14 , Aula Magna

User-facing tutorials typically combine code, narrative text, execution results, and visualization. However, the target audience of these tutorials can differ significantly, tutorials are often served to be part of the documentation to be accessed by individual users as part of their asynchronous learning, while at other times tutorials are presented at one-off workshops while they are deployed on specific science platforms.

This talk presents the best practices for reliable and reproducible tutorials assembled as part of a Scientific Python Ecosystem Coordination (SPEC) document. These practices distinguish between the different flavours of tutorials and offer guidance for each of them.
The talk specifically showcases how we have implemented and used these best practices at IRSA, and focuses on the ecosystem we adopted for maintaining, testing and deploying our tutorials to the scientific user community. In our approach, we treat these tutorials as library code, and test them in an automated and regular CI/CD setup we serve them in an aesthetically pleasing, user-friendly way.

See also: Talk slides (2.2 MB)

Brigitta is a developer at Caltech/IPAC-IRSA. She works on the NASA Astrophysics Science Platform (Fornax), and maintains various open source libraries in the astronomy, Scientific Python and Jupyter ecosystems including pyVO, astroquery, astropy, and numpy-tutorials.

https://github.com/bsipocz