Documentating software is part of the life of software engineers. But what kind of documentation do we need? In this episode I take you through three levels of documentation: the basic README and LICENSE files everyone should have, how to be good at writing git commit messages and using tools to turn your source code comments into browsable documentation.

Links

• https://www.sphinx-doc.org/
• https://pdoc.dev/docs/pdoc.html
  • https://docs.python.org/3/library/pydoc.html
• https://wiki.python.org/moin/DocumentationTools
• https://peps.python.org/pep-0287/ reStructuredText Docstring Format
• https://github.com/matiassingers/awesome-readme some README examples
  • https://dev.to/documatic/awesome-readme-examples-for-writing-better-readmes-3eh3
• https://www.gitkraken.com/learn/git/best-practices/git-commit-message GIT commit messaging
• https://www.warp.dev/terminus/git-commit-history Git Commit history

Don't be shy - say Hi

This podcast is brought to you by the Advanced Research Computing Centre of the University College London, UK.
Producer and Host: Peter Schmidt

Testing your software is part of development. In this episode I talk about different types of testing, automated tests, legacy code etc. My guest is Stef Piatek from UCL who tells us how he approaches testing in his daily work.

Links

• https://docs.python.org/3/library/unittest.html
• https://docs.pytest.org/
  • https://docs.pytest.org/en/7.1.x/how-to/monkeypatch.html PyTest Monkeypatch
• https://agiledata.org/essays/tdd.html test driven development TDD
• https://en.wikipedia.org/wiki/Extreme_programming
• https://joss.readthedocs.io/en/latest/review_criteria.html criteria for open source software reviews, which includes a section on testing
• https://www.freecodecamp.org/news/a-practical-guide-to-start-opensource-contributions/
• https://docs.github.com/en/actions GitHub Actions
• https://martinfowler.com Martin Fowler's great web site. Also look out for his book:
  • Working Effectively With Legacy Code - Michael Feathers, 2004, ISBN: 8601400968741

Don't be shy - say Hi

This podcast is brought to you by the Advanced Research Computing Centre of the University College London, UK.
Producer and Host: Peter Schmidt

In this episode I'll be discussing data formats such as CSV, JSON and YAML. My guest is Nick Radcliffe from Stochastic Solutions and the Uni. Edinburgh. Nick's expertise is in data science and he has a lot to share about data, data formats and how to use them.

Links

• https://www.linkedin.com/in/njradcliffe/ Nick's LinkedIn profile
• https://en.wikipedia.org/wiki/Comma-separated_values CSV formats
• https://www.json.org/json-en.html JSON
  • https://json-ld.org JSON for linked data
  • https://json-schema.org JSON schema
• https://yaml.org YAML
• https://parquet.apache.org Parquet by Apache
• https://hdfgroup.github.io/hdf5/ HDF5

Libraries

• https://numpy.org
• https://scipy.org
• https://scikit-learn.org/stable/
• http://www.tdda.info test driven data analysis

Don't be shy - say Hi

This podcast is brought to you by the Advanced Research Computing Centre of the University College London, UK.
Producer and Host: Peter Schmidt