Presentation Open Access

Writing Clean Scientific Software

Murphy, Nicholas A.

This presentation discusses strategies for writing clean scientific software.  Choosing meaningful variable names improves readability.  Functions should be short, do exactly one thing, and have no side effects.  High-level big picture code should be separated from low-level implementation details, for example by writing code as a top-down narrative.  Because comments often become out-of-date as code evolves, it is preferable to refactor code to improve readability rather than describe how it works.  Well-written tests increase the flexibility of code.  This presentation encourages us to think of code as communication.

This work was created with support from National Science Foundation (US) grant 1931388 to the Smithsonian Astrophysical Observatory. A minor portion of this presentation was adapted from the paper entitled "Best Practices for Scientific Computing" by G. Wilson et al., which is available under the Creative Commons Attribution 4.0 International (CC BY 4.0) license.
Files (643.1 kB)
Name Size
WritingCleanScientificSoftware.pdf
md5:4229bff05d7e36bd63e489bf891affa8
643.1 kB Download
  • Albert, K.; Bouquin, D.; Farber, A.; and Hoover, R. (2019). Copyright Guide for Scientific Software. Zenodo. http://doi.org/10.5281/zenodo.3581326

  • Feathers, M. (2004). Working Effectively with Legacy Code.

  • Fowler, M. (2011). Eradicating Non-Determinism in Tests. https://martinfowler.com/articles/nonDeterminism.html

  • Gamma, E.; Helm, R.; Johnson, R.; and Vlissides, J. (1995). Design Patterns: Elements of Reusable Object-Oriented Software.

  • Hicks, S. Code Is Communication. https://steven-j-hicks-speaking.netlify.app/code-is-communication/#1

  • Martin, R. C. (2009). Clean Code: A Handbook of Agile Software Craftsmanship.

  • Martin, R. C. (2018). Clean Architecture: A Craftsman's Guide to Software Structure and Design.

  • McConnell, S. (2004). Code Complete: A practical handbook of software construction, 2nd edition.

  • Wilson, G.; Aruliah, D. A.; Brown C. T.; Chue Hong, N. P.; Davis, M.; Guy, R. T. et al. (2014). Best Practices for Scientific Computing, PLoS Biology, 12, e1001745, https://doi.org/10.1371/journal.pbio.1001745

  • Wilson, G.; Bryan, J.; Cranston, K.; Kitzes, J.; Nederbragt, L.; Teal, T. K. (2017). Good enough practices in scientific computing. PLoS Computational Biology, 13, e1005510, https://doi.org/10.1371/journal.pcbi.1005510

722
221
views
downloads
All versions This version
Views 722722
Downloads 221221
Data volume 142.1 MB142.1 MB
Unique views 692692
Unique downloads 206206

Share

Cite as