Webinar: Testing and Documenting Your Code

Start Date: 
Jun 15 2016 - 12:00pm to 1:00pm
Alicia Klinvex, Sandia National Laboratories

This is Session 2 of the webinar series "Best Practices for HPC Software Developers," which is jointly organized by the IDEAS Project and the ALCF, NERSC, and OLCF computing facilities.

Software verification and validation are needed for high-quality and reliable scientific codes. For software with moderate to long lifecycles, a strong automated testing regime is indispensable for continued reliability. Similarly, comprehensive and comprehensible documentation is vital for code maintenance and extensibility. This presentation will provide guidelines on testing and documentation that can help to ensure high-quality and long-lived HPC software. We will present methodologies, with examples, for developing tests and adopting regular automated testing. We also will provide guidelines for minimum, adequate, and good documentation practices depending on the available resources of the development team.