aboutsummarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorJP-Ellis2017-02-09 14:38:59 +1100
committerJP-Ellis2017-02-09 16:51:09 +1100
commit0eb094cd065df90a1b1561c6526db06af58895b9 (patch)
treec570ba029b40f5f29e2ef3e0eca4c3e49a96ec57
parentee2f94257d583a103366b992102fca7440126813 (diff)
downloadaur-0eb094cd065df90a1b1561c6526db06af58895b9.tar.gz
Update Readme
Signed-off-by: JP-Ellis <josh@jpellis.me>
-rw-r--r--README.md34
-rw-r--r--README.org3
2 files changed, 34 insertions, 3 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..a6547eaaa050
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+Delphes
+=======
+
+[![AUR badge][AUR badge]][AUR]
+
+Delphes installer Arch Linux.
+
+[Delphes][homepage] is a C++ framework, performing a fast multipurpose detector
+response simulation. The simulation includes a tracking system, embedded into a
+magnetic field, calorimeters and a muon system. The framework is interfaced to
+standard file formats (e.g. Les Houches Event File or HepMC) and outputs
+observables such as isolated leptons, missing transverse energy and collection
+of jets which can be used for dedicated analyses. The simulation of the
+detector response takes into account the effect of magnetic field, the
+granularity of the calorimeters and sub-detector resolutions. Visualisation of
+the final state particles is also built-in using the corresponding ROOT library.
+
+If you use Delphes as part of a publication, you should include a citation to:
+
+ > Favereau, J. De, et al. “DELPHES 3: a modular framework for fast simulation
+ > of a generic collider experiment.” *Journal of High Energy Physics*.
+ > [doi:10.1007/jhep02(2014)057](https://doi.org/10.1007/jhep02(2014)057).
+
+Also, please note that Delphes relies on a few external packages. If they are
+used they should be cited as well. For instance, the jet clustering procedure in
+Delphes is performed via the ​FastJet package. If your analysis involves jets,
+you should explicitly include both a reference for the ​FastJet package and for
+the relevant clustering algorithm you are using.
+
+
+[homepage]: https://cp3.irmp.ucl.ac.be/projects/delphes
+[doi]: https://dx.doi.org/10.1007/jhep02(2014)057
+[AUR]: https://aur.archlinux.org/packages/delphes/
+[AUR badge]: https://img.shields.io/aur/version/delphes.svg
diff --git a/README.org b/README.org
deleted file mode 100644
index 9316b78b0604..000000000000
--- a/README.org
+++ /dev/null
@@ -1,3 +0,0 @@
-#+TITLE: Delphes [[https://aur.archlinux.org/packages/delphes/][https://img.shields.io/aur/version/delphes.svg]]
-
-Delphes bundled for installation on Arch Linux.