Recognizing Software Contributions in High-Energy Physics

In the field of high-energy physics (HEP), Software plays a crucial role in research. It is often created as a byproduct of scientific work and is essential for conducting Experiments and analyzing data. However, software does not always receive the same attention as traditional research outputs like journal articles or data sets. In November 2022, a workshop was held to discuss how software should be cited in HEP and to look at ways to give proper credit for software contributions.

#Importance of Software in Research

Software in HEP is a significant asset that researchers rely on. It is used for simulations, data analysis, and other important tasks. Despite its importance, there is a gap in how software is treated compared to other research products. This inconsistency can lead to underappreciation of the work that goes into developing and maintaining software.

#Goals of the Workshop

The workshop aimed to bring together various stakeholders to discuss how software citation Practices can evolve in HEP. This included representatives from HEP experiments, software development communities, scientific publishers, and those involved in providing tools and resources for citation. Participants shared experiences regarding current practices and future recommendations for improving software citation.

#Current Practices in HEP Experiments

There are three major experiments in HEP: ATLAS, CMS, and LHCb. Each has developed its own methods for citing software used in their research.

#ATLAS Practices

ATLAS takes a broad approach to software citation. They often cite a general statement that covers all ATLAS software and provides links to repositories where the code can be found. They also reference specific software papers for particular tools like detector simulation software and Monte Carlo generators.

However, ATLAS does not always cite the software used for statistical analysis, focusing instead on the papers that describe the methods. This inconsistency means that not all software contributions receive recognition, although they are beginning to include more Citations for important libraries.

#CMS Practices

CMS has a more consistent culture of citing software, particularly Monte Carlo generators and machine learning tools. They recognize the need to improve the citation of their own software, both in internal documents and publications. CMS is interested in publishing research papers focused on their software, which would enhance visibility and citation practices.

#LHCb Practices

LHCb has taken proactive steps to encourage software citation. After recommendations from a previous conference, they developed a template for citing software commonly used in research. Analysis teams are encouraged to fill out this template with software citations, but it is not mandatory. This reliance on community norms emphasizes the need for clearer guidelines on software citation practices.

#Perspectives from Software Projects

Different software projects within the HEP community have varying views on citation. The ROOT team, for example, does not prioritize software citations, believing that the current citation practices in the field work well for larger projects. They express concern over the extra effort required to maintain citation information.

In contrast, the Scikit-HEP community values software citation and has made efforts to align with broader scientific standards for citation. They want to encourage the proper attribution of contributions from developers and would appreciate clear guidelines to help users cite software correctly.

The MCnet community, which focuses on Monte Carlo simulations, benefits from consistent citation practices among the LHC experiments. They have established clear guidelines and provided citation information directly in their software. However, they have concerns over the model of citing papers for large software releases, which does not adequately recognize the ongoing maintenance and development efforts.

#Insights from the Publishing Community

Input from the publishing community is also essential for improving software citation practices. INSPIRE is a key player in managing publication information in HEP. They are working to incorporate software citations into their records, which would help researchers find and reference software more easily.

Elsevier emphasizes the need for the scientific community to agree on software citation standards. Once established, these guidelines can help journal editors and reviewers understand how to handle software citations properly.

The Journal of Open Source Software (JOSS) aims to support the citation of high-quality research software and bridge the gap between traditional publication practices and software citation. They can provide useful guidelines for the HEP community to adopt.

#Recommendations for Best Practices

Based on discussions from the workshop, several recommendations emerged to improve software citation in HEP.

#Clear Documentation

Software projects should provide clear and easily accessible documentation on how to cite them. This information should be prominent in repositories and public documentation sites, making it simple for users to find citation guidelines.

#Use of Standardized Formats

Adopting a standardized citation format, like the Citation File Format (CFF), can help streamline how software citations are handled. CFF files are human- and machine-readable and can be easily integrated with services like GitHub and Zenodo, making them a practical choice for software projects.

#Version Control

Including version information in citations is important. This allows others to identify the specific software version that was used in any given research. By maintaining version control and documenting changes, researchers can ensure accurate attribution in their publications.

#Consistent Practices Across the Field

While different experiments and software communities may practice citation differently, establishing a consensus on software citation practices is crucial. The HEP community must recognize the importance of software in research and agree on commonly accepted practices to promote better citation habits.

#Conclusion

As software continues to play an integral role in high-energy physics research, it is essential that the community evolves its understanding and practices around software citation. By recognizing software as a legitimate research output, providing clear guidelines, and adopting standardized practices, the HEP community can ensure that contributions from software developers receive the acknowledgment they deserve.

The progress made in discussions at the recent workshop provides a pathway toward improved software citation practices. While challenges remain, there is a shared commitment within the community to enhance the recognition of software in the research process and to develop more effective citation standards moving forward.