Line data    Source code

       1           0 : \cond NEVER
       2             : Distributed under the MIT License.
       3             : See LICENSE.txt for details.
       4             : \endcond
       5             : 
       6             : # Publication policies {#publication_policies}
       7             : 
       8             : SpECTRE is an open-source code that is developed and maintained by the
       9             : [Simulating eXtreme Spacetimes (SXS) collaboration](https://black-holes.org). We
      10             : ask all authors of scientific publications that make use of SpECTRE's code or
      11             : data to follow the citation guidelines laid out in the section \ref citing. An
      12             : additional set of guidelines, laid out in the section \ref
      13             : sxs_publication_policies applies to publications by members of the SXS
      14             : collaboration.
      15             : 
      16             : ## Citing SpECTRE {#citing}
      17             : 
      18             : Please cite SpECTRE in any publications that make use of its code or data. Cite
      19             : the latest version that you use in your publication. The DOI for this version
      20             : is:
      21             : 
      22             : - DOI: [\spectredoi](https://doi.org/\spectredoi)
      23             : 
      24             : You can cite this BibTeX entry in your publication:
      25             : 
      26             : \include citation.bib
      27             : 
      28             : To aid reproducibility of your scientific results with SpECTRE, we recommend you
      29             : keep track of the version(s) you used and report this information in your
      30             : publication. We also recommend you supply the YAML input files and, if
      31             : appropriate, any additional C++ code you wrote to compile SpECTRE executables as
      32             : supplemental material to the publication.
      33             : 
      34             : ## Policies that apply to SXS publications {#sxs_publication_policies}
      35             : 
      36             : These policies apply to all "science papers" by members of the SXS collaboration
      37             : that make use of SpECTRE’s code or data, as defined by the
      38             : [SXS policies](https://github.com/sxs-collaboration/WelcomeToSXS/blob/master/SxsPolicies.md).
      39             : 
      40             : Our publication policies have the goal that contributions to SpECTRE gain value
      41             : in academia. For SpECTRE to be successful, it must be worth a junior
      42             : researcher's time to contribute to the code. Contributions are already partially
      43             : acknowledged through authorship on the DOI, as laid out in the `Metadata.yaml`
      44             : file. However, authorship on the DOI alone doesn’t hold enough value in academia
      45             : to make code contributions worthwhile that have no immediate science paper
      46             : associated with them, but that enable science papers down the line. Therefore,
      47             : our policies have the purpose to grant authorship rights on science papers to
      48             : the developers of code that enabled them.
      49             : 
      50             : ### Guidelines for SXS paper authors
      51             : 
      52             : - If you're a member of the SXS collaboration and use SpECTRE for your paper,
      53             :   you should probably include a list of SpECTRE developers as co-authors per the
      54             :   [SXS policies](https://github.com/sxs-collaboration/WelcomeToSXS/blob/master/SxsPolicies.md).
      55             : - To obtain the list of co-authors, reach out to any of the people listed in the
      56             :   [SpECTRE core developers](https://github.com/orgs/sxs-collaboration/teams/spectre-core-devs/members)
      57             :   team on GitHub. Do this as early as possible, e.g., when you are setting up a
      58             :   paper repository to share early drafts and results with other co-authors.
      59             :   To contact the SpECTRE core developers, use a communication channel of your
      60             :   choice. Here are a few possibilities:
      61             : 
      62             :   - Send a message on Slack.
      63             :   - Knock on their office door.
      64             :   - Send an email to one of the core developers, or to
      65             :     [core-devs@spectre-code.org](mailto:core-devs@spectre-code.org).
      66             :     Possible wording of the email:
      67             : 
      68             :     > Dear SpECTRE core devs,
      69             :     >
      70             :     > I am / we are preparing a paper on [title or topic]. I am / we are using
      71             :     > SpECTRE in this way:
      72             :     >
      73             :     > - [Describe your use of SpECTRE briefly, e.g. as a bulleted list. Mention
      74             :     >   which parts of SpECTRE you are using in particular, e.g. the initial
      75             :     >   data solver, the evolution scheme, the wave extraction, etc.]
      76             :     >
      77             :     > Claims of the paper:
      78             :     >
      79             :     > - [Summarize the main claims you make in the paper. In particular, does
      80             :     >   the paper make any claims about physics?]
      81             :     >
      82             :     > Please respond with the list of co-authors to include in the paper.
      83             :     >
      84             :     > Best regards,
      85             :     > [you]
      86             : 
      87             :   If you already have a draft or outline of your paper available, please feel
      88             :   free to attach it, to give the core developers a better idea of the ways you
      89             :   are using SpECTRE.
      90             : 
      91             :   The core developers will discuss among themselves, following the guidelines
      92             :   listed below, and will get back to you with a list of co-authors and their
      93             :   contributions. In the spirit of transparency within the collaboration the core
      94             :   developers will also share your description of the paper and the suggested
      95             :   list of co-authors with the
      96             :   [spectre-devel@black-holes.org](mailto:spectre-devel@black-holes.org) mailing
      97             :   list.
      98             : - Please make the paper draft available to all co-authors as early as possible,
      99             :   e.g, by sharing access to a Git repository. This allows the co-authors to
     100             :   contribute their technical expertise to the SpECTRE-related part of the paper,
     101             :   and it also makes them aware of the ongoing work, in the spirit of
     102             :   transparency and collaboration within SXS.
     103             : 
     104             : ## Guidelines to decide who has authorship rights on SXS science papers that use SpECTRE
     105             : 
     106             : - A contribution to SpECTRE on the order of ~500 lines of code or more should
     107             :   earn you authorship rights on the first science paper that uses the feature.
     108             :   Major contributions, such as writing a full evolution system, earns you
     109             :   authorship rights on the first three science papers that use the feature.
     110             :   "Using the feature" means the code contributes to the result of the paper,
     111             :   either obviously like a new coordinate map in the domain, or in a more subtle
     112             :   way like an optimization that made the simulation run faster.
     113             : - Core developers earn authorship rights to all science papers that use SpECTRE
     114             :   for their infrastructure contributions.
     115             : - In case of controversy, contact any person who you feel comfortable raising
     116             :   your concern with, such as one of the core developers, a member of the
     117             :   [executive committee](https://github.com/sxs-collaboration/WelcomeToSXS/blob/master/SxsPolicies.md#executive-committee),
     118             :   or the [ombudsperson](https://github.com/sxs-collaboration/WelcomeToSXS/blob/master/SxsPolicies.md#ombudsperson).