Merge branch 'DocumentationTesting'

.gitignore

@@ -8,6 +8,8 @@
 !*.sh
 !CHANGELOG 
 !README.md
+!paper/paper.md
+!paper/paper.bib
 !README.swifter 
 !*.in
 dump*

README.md

@@ -703,6 +703,19 @@ To get a sense of the scope of your desired simulation, it is recommended that y
 
 ---
 
+#### Community Guidelines
+
+**Contributing to Swiftest**
+Swiftest is open source and can be freely accessed through our [GitHub page](https://github.itap.purdue.edu/MintonGroup/swiftest). If you wish to make a change and have that change incorporated into the published version of Swiftest, please issue a pull request. If you wish to edit Swiftest for your own personal use, no pull request is necessary.
+
+**Reporting an Issue**
+If you stumble upon a bug or issue with the functionality of Swiftest, we want to hear about it! If you have a fix for this bug, please issue a pull request. If you do not have a fix for the bug and would like to report it, please contact the Purdue Swiftest Team via email (cwishard@purdue.edu).
+
+**User Support**
+For help using Swiftest, please contact the Purdue Swiftest Team via email (cwishard@purdue.edu).
+
+---
+
 #### Licensing Agreement
 
 Swiftest is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

paper/paper.bib

@@ -0,0 +1,32 @@
+@article{Levison:1994,
+  	Author = {{Levison}, H. and {Duncan}, M.},
+  	Journal = {Icarus},
+  	Title = {{The Long-Term Dynamical Behavior of Short-Period Comets}},
+  	Year = 1994, 
+   Month = mar, 
+   Volume = 108, 
+   DOI =  {https://doi.org/10.1006/icar.1994.1039},
+   url = {https://www.sciencedirect.com/science/article/pii/S0019103584710396?via%3Dihub}
+}
+
+@article{Duncan:1998,
+  	Author = {{Duncan}, M., {Levison}, H., and {Lee}, M. H.},
+  	Journal = {The Astronomical Journal},
+  	Title = {{A Multiple Time Step Symplectic Algorithm for Integrating Close Encounters}},
+  	Year = 1998, 
+   Month = oct, 
+   Volume = 116, 
+   DOI =  {https://doi.org/10.1086/300541},
+   url = {https://iopscience.iop.org/article/10.1086/300541}
+}
+
+@article{Leinhardt:2012,
+  	Author = {{Leinhardt}, Z. and {Stewart}, S.},
+  	Journal = {The Astronomical Journal},
+  	Title = {{Collisions between Gravity-dominated Bodies. I. Outcome Regimes and Scaling Laws.}},
+  	Year = 2012, 
+   Month = dec, 
+   Volume = 745, 
+   DOI =  {https://doi.org/10.1088/0004-637X/745/1/79},
+   url = {https://iopscience.iop.org/article/10.1088/0004-637X/745/1/79}
+}

paper/paper.md

@@ -0,0 +1,47 @@
+---
+title: 'Swiftest: An N-body Integrator for Gravitational Systems'
+tags:
+  - Python
+  - Fortran
+  - Astronomy
+  - Dynamics
+  - N-body
+  - Planetary Systems
+authors:
+  - name: Carlisle Wishard
+    equal-contrib: true 
+    affiliation: 1
+  - name: David Minton
+    equal-contrib: true 
+    affiliation: 1
+  - name: Jennifer Pouplin
+    corresponding: true 
+    affiliation: 2
+  - name: Jake Elliott
+    corresponding: true 
+    affiliation: 2
+  - name: Dana Singh
+    corresponding: true 
+    affiliation: 2
+affiliations:
+ - name: Department of Earth, Atmospheric, and Planetary Sciences, Purdue University, USA
+   index: 1
+ - name: Independent Researcher, USA
+   index: 2
+date: 31 October 2022
+bibliography: paper.bib
+---
+
+# Summary
+
+The dynamical evolution of planetary systems is dominated by gravitational interactions between massive bodies. Determining the orbits of massive bodies over long time scales is the first step towards understanding the formation and evolution of planets, moons, asteroids, comets, and more. To model these systems, which often include hundreds or thousands of gravitationally interacting bodies, a numerical tool called an N-body integrator is often employed. 
+
+# Statement of need
+
+`Swiftest` is a software package designed to model gravitationally dominated systems. The main body of the program is written in Modern Fortran, taking advantage of the object-oriented capabilities included with Fortran 2003 and the parallel capabilities included with Fortran 2008 and Fortran 2018. `Swiftest` also includes a Python package that allows the user to quickly generate input and process output from the main integrator. `Swiftest` uses a NetCDF output file format which makes data analysis with the `Swiftest` Python package a streamlined and flexible process for the user. 
+
+Building off a strong legacy, including its predecessors `Swifter` [@Duncan:1998] and `Swift` [@Levison:1994], `Swiftest` takes the next step in modeling gravitationally dominated systems by including collisional fragmentation. Our collisional fragmentation algorithm, `Fraggle` (based on the work of @Leinhardt:2012), is designed to resolve collisions between massive bodies and generate collisional debris. `Swiftest` fully incorporates this debris into the gravitational system, evolving these new bodies along with pre-existing bodies. This allows for a more complete model of the orbital evolution of the system and the growth of massive bodies. 
+
+The combination of modern programming practices, flexible data processing tools, and the latest advances in the field of collisional dynamics make `Swiftest` the ideal tool for studying the formation of planetary systems, the growth of planetary moons, the evolution of asteroid families, and beyond.
+
+# References