Skip to main content
SHARE
Publication

Preferred Practices Through a Project Template...

by Chen Zhang, Peter F Peterson, Jose M Borreguero Calvo, Kevin A Tactac
Publication Type
Conference Paper
Book Title
USRSE24 Conference Proceedings
Publication Date
Page Numbers
1 to 5
Publisher Location
United States of America
Conference Name
US-RSE Conference 2024: 2nd Annual Conference of the US Research Software Engineer Association
Conference Location
Albuquerque, New Mexico, United States of America
Conference Sponsor
US-RSE
Conference Date
-

In the realm of scientific software development, adherence to best practices is often advocated. However, implementing these can be challenging due to differing opinions. Certain aspects, such as software licenses and naming conventions, are typically left to the discretion of the development team. Our team has established a set of preferred practices, informed by, but not limited to, widely accepted best practices. These preferred practices are derived from our understanding of the specific contexts and user needs we cater to. To facilitate the dissemination of these practices among our team and foster standardization with collaborating domain scientists, we have created a project template for Python projects. This template serves as a platform for discussing the implementation of various decisions. This paper will succinctly delineate the components that constitute an effective project template and elucidate the advantages of consolidating preferred practices in such a manner.