sphenix-l AT lists.bnl.gov
Subject: sPHENIX is a new detector at RHIC.
List archive
- From: Christine Nattrass <saccharomyces.cerevisae AT gmail.com>
- To: "sphenix-l AT lists.bnl.gov" <sphenix-l AT lists.bnl.gov>
- Subject: [Sphenix-l] Draft HEPData guidelines
- Date: Fri, 26 Apr 2024 13:51:21 -0400
Dear all
Following the discussion today in the general meeting, here are draft HEPData guidelines
https://docs.google.com/document/d/1vcV9nZ2IixjOt-kIKWvMvkMYf5vwO2UBThmsbnCSQ8Y/edit?usp=sharing
If possible, please add comments to the Google doc if you have any comments. I have also pasted them below my signature for those without access to Google docs, but this will not have any updates.
-- Greetings, Dr. Christine Nattrass -- she, her, hers Professor Undergraduate Program Director Completed Tier 2 Safe Zone training Physics Department University of Tennessee, Knoxville Office: SERF 609 Office Hours: by appointment Address: 1408 Circle Drive Knoxville, TN 37996 phone number at UTK: (865) 974-6211 http://nattrass.utk.edusPHENIX HEPData Guidelines
In order to disseminate data from published papers, sPHENIX will post data on HEPData. Preliminary data will not be posted on HEPData. Except in exceptional cases approved by the Publication Board, a draft HEPData entry including all data to be made public shall be submitted to a private github repository and distributed to the IRC before submission of the paper.. The data may be posted to HEPData after submission of the paper, but they must be posted shortly after the paper is accepted for publication. The HEPData entry may contain supplemental data, at the discretion of the Paper Preparation Group (PPG) and Internal Review Committee (IRC). The HEPData entry serves as one of the final, official records of the measurement in perpetuity and, as such, the authors are encouraged to include any data which may become useful in the future for interpreting the data, making comparisons to models, or reproducing the results. This may include information which is not part of the paper such as response matrices, additional data which were not included in the paper, and information about model comparisons reported in the paper. The PPG is responsible for notifying the IRC and collaboration of any such supplemental data to be included in the HEPData entry and including it in the review process for the paper. While it is possible to replace a HEPData entry, any submissions which are approved by the collaboration remain publicly available. The primary responsibility for the accuracy and aesthetic quality of the HEPData entry rests with the PPG, followed by the IRC. The HEPData coordinator may provide additional feedback and provides an additional cross check on the draft HEPData entry. The HEPData coordinator is particularly responsible for components of the entry which are not visible on the web site but are important for searches of data, including reaction types and keywords. The HEPData coordinator may make edits to these metadata, notifying the PPG and IRC. The HEPData coordinator will maintain documentation to assist the PPG and IRC in generating the HEPData entry, maintain a git repository for HEPData entries, and manage access to the git repository. The HEPData coordinator will coordinate with the PPG and IRC to assign an uploader from the PPG and a reviewer from the IRC for the final entry. While aesthetic choices are primarily left to the PPG and IRC, some guidelines are outlined below: The abstract should be preceded by, “BNL-RHIC,” to follow conventions in the field. Latex should be used for variables and symbols where possible. (It is not possible in table titles.) The HEPData entry should generally be clear and coherent independent of the paper inasmuch as possible. Table captions should be nearly identical to the figure captions in the paper, with edits as appropriate to make it a suitable table caption (for example, if the data in a particular Figure is split among multiple HEPData entries). When bins were used in the analysis, the bin ranges should be included in the entry, even if averages are also included. If any measure of centrality is used (Nbin, Npart), the actual centrality bins should be included as well. The bins should be listed as the first x-axis. Data series in each individual table should have the same number of data points. These features facilitate generation of a Rivet analysis. The reaction type should be set appropriately for each data series. This means that data from different types of collisions should generally be in different tables. Data should generally appear in the HEPData entry in the same order as in the paper. If all data in a figure have the same number of data points, they should appear in the same table. The y-axis title should be descriptive and should generally match the y-axis of the corresponding plot in the paper. The table should include qualifiers as appropriate to indicate kinematic selections. A thumbnail image of the appropriate figure in the paper should be included with the data table. Keywords are useful for searching for different types of data. The official list of keywords generally does not include many terms appropriate for heavy ion collisions. Where similar papers have been published by other collaborations, the PPG should look at those entries and try to use the same keywords. Numbers should generally be formatted with precision following PDG guidelines, meaning that the numbers are not listed to greater precision than their accuracy. The PPG is encouraged to use the python script available for formatting numbers in this way. All uncertainties on the data should be included in the table, as this is the assumption of most end users of HEPData. The PPG should strongly consider listing different components of the systematic uncertainty separately in the data table, as well as indicating whether or not these components are correlated point to point.
- [Sphenix-l] Draft HEPData guidelines, Christine Nattrass, 04/26/2024
Archive powered by MHonArc 2.6.24.