WS24:
Best Practices for Modern Open-Source Research Codes


Submit an Abstract to this Session


Session ID#: 52075

Session Description:
Modern science increasingly relies on code, ranging from small scripts to workflows with many interacting parts. Reproducibility and extension of studies employing these codes require that they are accessible. The open-source community has established modern best-practices for making software available, usable, and maintainable. In this workshop, we will demonstrate a workflow for publishing research code following these best-practices. We will cover open-source licenses, version control, automated testing, documentation, and continuous integration. The workshop will be hands-on: participants will work to set up a project using sample code provided by the instructors. By the end, participants will have the knowledge needed to continue learning independently and apply these practices to their own research code. These resources can be applied to any programming language or scientific discipline.
Conveners:  Lion Krischer, ETH Zurich, Department of Earth Sciences, Institute of Geophysics, Zurich, Switzerland, Lindsey Justine Heagy, University of British Columbia, Vancouver, BC, Canada and Florian M. Wagner, Steinmann Institute, University of Bonn, Department of Geophysics, Bonn, Germany
Submitter:  Leonardo Uieda, University of Hawaii at Manoa, School of Ocean & Earth Science & Technology, Honolulu, HI, United States
Presenters:  Leonardo Uieda, University of Hawaii at Manoa, School of Ocean & Earth Science & Technology, Honolulu, HI, United States, Lindsey Justine Heagy, University of British Columbia, Vancouver, BC, Canada, Florian M. Wagner, Steinmann Institute, University of Bonn, Department of Geophysics, Bonn, Germany and Lion Krischer, Mondaic AG, Munich, Switzerland
Onsite Contact:  Leonardo Uieda, University of Hawaii at Manoa, School of Ocean & Earth Science & Technology, Honolulu, HI, United States

Cross-Listed:
  • G - Geodesy
  • IN - Earth and Space Science Informatics
  • NS - Near Surface Geophysics
  • S - Seismology
Index Terms:

0599 General or miscellaneous [COMPUTATIONAL GEOPHYSICS]
1908 Cyberinfrastructure [INFORMATICS]
1976 Software tools and services [INFORMATICS]
1998 Workflow [INFORMATICS]

Abstracts Submitted to this Session:

No submissions have been made yet.

See more of: Scientific Workshops