Published August 21, 2024 | Version v1
Conference paper Open

Preferred Practices Through a Project Template

Description

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.

Files

USRSE24_Python_Project_Template.pdf

Files (119.8 kB)

Name Size Download all
md5:5a98ae2a3d463bb6f7844b4a2d48cd4b
119.8 kB Preview Download

Additional details

Software

Repository URL
https://github.com/neutrons/python_project_template
Programming language
Python