Commit 495e2e64 authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Updated the documentation to add a standardised acknowledgment

parent 1126ea74
Matthieu Schaller schaller@strw.leidenuniv.nl
Pedro Gonnet gonnet@google.com
Matthieu Schaller matthieu.schaller@durham.ac.uk
Aidan Chalk aidan.chalk@durham.ac.uk
Peter W. Draper p.w.draper@durham.ac.uk
Bert Vandenbroucke bert.vandenbroucke@gmail.com
......@@ -13,3 +13,8 @@ Josh Borrow joshua.borrow@durham.ac.uk
Loic Hausammann loic.hausammann@epfl.ch
Yves Revaz yves.revaz@epfl.ch
Jacob Kegerreis jacob.kegerreis@durham.ac.uk
Mladen Ivkovic mladen.ivkovic@epfl.ch
Stuart McAlpine stuart.mcalpine@helsinki.fi
Folkert Nobels nobels@strw.leidenuniv.nl
John Helly j.c.helly@durham.ac.uk
Alexei Borissov alexei.borissov@ed.ac.uk
......@@ -28,6 +28,42 @@ Please feel free to submit issues to this repository, or even pull
requests. We will try to deal with them as soon as possible, but as the
core development team is quite small this could take some time.
Disclaimer
----------
We would like to emphasise that SWIFT comes without any warranty of accuracy,
correctness or efficiency. As mentioned in the license, the software comes
`as-is` and the omen is on the user to get meaningful results. Whilst the
authors will endeavour to answer questions related to using the code, we
recommend users build and maintain their own copies. This documentation contains
the most basic information to get started. Reading it and possibly also the
source code is the best way to start running simulations.
The users are responsible to understand what the code is doing and for the
results of their simulation runs.
Note also that the values of the parameters given in the examples are only
indicative. We recommend users experiment by themselves and a campaign of
experimentation with various values is highly encouraged. Each problem will
likely require different values and the sensitivity to the details of the
physical model is something left to the users to explore.
Acknowledgment & Citation
-------------------------
In order to keep track of usage and measure the impact of the software, we
kindly ask users publishing scientific results using SWIFT to add the following
sentence to the acknowledgment section of their papers:
"The research in this paper made use of the SWIFT open-source
simulation code (http://www.swiftsim.com, Schaller et al. 2018)
version X.Y.Z."
with the version number set to the version used for the simulations and the
reference pointing to the ASCL entry of the code: https://ascl.net/1805.020.
Contribution Guidelines
-----------------------
......
.. Citing SWIFT
Matthieu Schaller, 5th April 2020
Disclaimer, Citing SWIFT & Giving Credit
========================================
First of all, thank you for using SWIFT for your projects!
.. figure:: SWIFT_logo.png
:width: 300px
:align: center
:alt: SWIFT logo
Licensing
~~~~~~~~~
SWIFT is licensed under the LGPL version 3.0. A copy of the license is provided
in the file ``COPYING`` at the root of the repository. It can also be found
online `here <https://www.gnu.org/licenses/lgpl-3.0-standalone.html>`_ as an
extension to the `GPL <https://www.gnu.org/licenses/gpl-3.0-standalone.html>`_.
.. figure:: https://www.gnu.org/graphics/lgplv3-with-text-154x68.png
:width: 100px
:alt: LGPL v3.0 logo
Disclaimer
~~~~~~~~~~
We would like to emphasise that SWIFT comes without any warranty of accuracy,
correctness or efficiency. As mentioned in the license, the software comes
`as-is` and the omen is on the user to get meaningful results. Whilst the
authors will endeavour to answer questions related to using the code, we
recommend users build and maintain their own copies. This documentation contains
the most basic information to get started. Reading it and possibly also the
source code is the best way to start running simulations.
The users are responsible to understand what the code is doing and for the
results of their simulation runs.
Note also that the values of the parameters given in the examples are only
indicative. We recommend users experiment by themselves and a campaign of
experimentation with various values is highly encouraged. Each problem will
likely require different values and the sensitivity to the details of the
physical model is something left to the users to explore.
Acknowledgment & Citation
~~~~~~~~~~~~~~~~~~~~~~~~~
In order to keep track of usage and measure the impact of the software, we
kindly ask users publishing scientific results using SWIFT to add the following
sentence to the acknowledgment section of their papers:
.. code-block:: text
The research in this paper made use of the SWIFT open-source simulation code
(http://www.swiftsim.com, Schaller et al. 2018) version X.Y.Z.
with the version number set to the version used for the simulations and the
reference pointing to the `ASCL entry <https://ascl.net/1805.020>`_ of the
code. This corresponds to the following bibtex citation block:
.. code-block:: bibtex
@MISC{2018ascl.soft05020S,
author = {{Schaller}, M. et al.},
title = "{SWIFT: SPH With Inter-dependent Fine-grained Tasking}",
keywords = {Software },
howpublished = {Astrophysics Source Code Library},
year = 2018,
month = may,
eid = {ascl:1805.020},
pages = {ascl:1805.020},
archivePrefix = {ascl},
eprint = {1805.020},
adsurl = {https://ui.adsabs.harvard.edu/abs/2018ascl.soft05020S},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
......@@ -14,6 +14,7 @@ difference is the parameter file that will need to be adapted for SWIFT.
.. toctree::
:maxdepth: 2
CitingSWIFT/index
GettingStarted/index
CommandLineOptions/index
ParameterFiles/index
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment