Merge branch 'main' of https://github.com/MSABuschman/sledgeHAMR

Author: MSABuschmann

README.md

@@ -1,3 +1,5 @@
+[![arXiv](https://img.shields.io/badge/arXiv-2404.02950%20-green.svg)](https://arxiv.org/abs/2404.02950)
+
 # Sledgehamr: Simulating scalar fields with adaptive mesh refinement
 Sledgehamr (**S**ca**L**ar fi**E**ld **D**ynamics **G**etting solv**E**d wit**H** **A**daptive **M**esh **R**efinement) is an AMReX-based code to simulate the dynamics of coupled scalar fields on a 3-dimensional mesh. Adaptive mesh refinement (AMR) can boost performance if spatially localized regions of the scalar field require high resolution. Compatible with both GPU and CPU clusters, sledgehamr offers a flexible and customizable framework. This framework enables various applications, such as the generation of gravitational wave spectra.
 
@@ -6,7 +8,7 @@ Sledgehamr (**S**ca**L**ar fi**E**ld **D**ynamics **G**etting solv**E**d wit**H*
 </p>
 
 For a detailed description of the code please consult the accompanying paper:
-https://arxiv.org/abs/23xx.xxxxx
+https://arxiv.org/abs/arXiv:2404.02950
 
 For questions, comments, or bug reports please use the GitHub issues feature, or contact me via email:
 [email protected]
@@ -18,23 +20,33 @@ [email protected]
 * FFTW3
 * Boost
 
-### Create a project
-Sledgehamr comes with a few different physics scenarios already implemented such as axion strings and a first-order phase transition of a single scalar field + gravitational waves, as well as two example projects ```MinimalExample``` and ```NextToMinimalExample```. The accompanying paper describes in detail how other scenarios can be implemented.
-
 ### Running the minimal examples
 The minimal examples can be run by following the instructions in the Jupyter notebooks ```notebooks/MinimalExample.ipynb``` and ```notebooks/NextToMinimalExample.ipynb```.
 
+### Create a project
+Sledgehamr comes with a few different physics scenarios already implemented such as axion strings and a first-order phase transition of a single scalar field + gravitational waves, as well as two example projects ```MinimalExample``` and ```NextToMinimalExample```. The accompanying paper describes in detail how other scenarios can be implemented.
+
 ## Code documentation
 * https://msabuschmann.github.io/sledgehamr/
-* https://arxiv.org/abs/23xx.xxxxx 
+* https://arxiv.org/abs/2404.02950
 
 ## How to cite
 If you use sledgehamr, please cite its accompanying paper:
 
-* Malte Buschmann, "Sledgehamr: Simulation scalar fields with adaptive mesh refinement",
-arXiv:23xx.xxxxx [hep-ph].
+* Malte Buschmann, "Sledgehamr: Simulation Scalar Fields with Adaptive Mesh Refinement",
+arXiv:2404.02950
 
 BibTex:
+```
+@misc{buschmann2024sledgehamr,
+      title={Sledgehamr: Simulating Scalar Fields with Adaptive Mesh Refinement}, 
+      author={Malte Buschmann},
+      year={2024},
+      eprint={2404.02950},
+      archivePrefix={arXiv},
+      primaryClass={hep-ph}
+}
+```
 
 ## Publications using this code