diff --git a/docs/getting-started-guide/index.rst b/docs/getting-started-guide/index.rst index 790e0d231..66fca89e4 100644 --- a/docs/getting-started-guide/index.rst +++ b/docs/getting-started-guide/index.rst @@ -4,6 +4,29 @@ Getting Started =============== +Swiftest is a re-write of the `Swifter `__ software package that incorporates modern programming techniques and performance +improvements. Swiftest contains the following numerical integrators: + +- **Wisdom-Holman Mapping (WHM)** - A symplectic n-body mapping method. + See `Wisdom & Holman (1991) `__. +- **Regularized Mixed Variable Symplectic (RMVS)** - An extension of WHM that is capable of handling close encounters between test + particles and massive bodies. See `Levison & Duncan (1994) `__. +- **Democratic Heliocentric (HELIO)** - A symplectic integrator that uses the democratic heliocentric coordinate frame. See +- `Duncan, Levison, & Lee (1998) `__. +- **Symplectic Massive Body Algorithm (SyMBA)** - An extension of HELIO that is capable of handling close encounters between massive bodies. + See `Duncan, Levison, & Lee (1998) `__. + +Swiftest also includes the collisional fragmentation algorithm *Fraggle*, which can be used to model collisional fragmentation when using the SyMBA integrator. +Fraggle is designed to resolve collisions between massive bodies by determining the collisional regime, derived from the work of `Leinhardt & Stewart +(2012) `__, and generating the appropriate mass distribution of fragments. Swiftest +fully incorporates collisional fragments into the gravitational system, evolving these new bodies along with pre-existing bodies, including +their growth and any future fragmentation events in which they are involved. + +Swiftest is written in Modern Fortran and is designed to be run from Python. The Python package provides a set of tools for generating +initial conditions, running simulations, and processing output data. Swiftest can also be run from the command line using the ``swiftest_driver`` executable, +provided that initial conditions and configuration files are available in the path. + + Installation ------------ diff --git a/docs/index.rst b/docs/index.rst index ed9cb22ac..a7e43d04d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,25 +3,8 @@ Swiftest ======== -Swiftest is a software packaged designed to model the dynamical evolution of gravitational systems. Swiftest is a re-write of the -`Swifter `__ software package that incorporates modern programming techniques and performance -improvements. -Swiftest contains the following numerical integrators: - -- **Wisdom-Holman Mapping (WHM)** - A symplectic n-body mapping method. - See `Wisdom & Holman (1991) `__. -- **Regularized Mixed Variable Symplectic (RMVS)** - An extension of WHM that is capable of handling close encounters between test - particles and massive bodies. See `Levison & Duncan (1994) `__. -- **Democratic Heliocentric (HELIO)** - A symplectic integrator that uses the democratic heliocentric coordinate frame. See -- `Duncan, Levison, & Lee (1998) `__. -- **Symplectic Massive Body Algorithm (SyMBA)** - An extension of HELIO that is capable of handling close encounters between massive bodies. - See `Duncan, Levison, & Lee (1998) `__. - -Swiftest also includes the collisional fragmentation algorithm **Fraggle**, an addition to the SyMBA integrator. Fraggle is designed to -resolve collisions between massive bodies by determining the collisional regime, derived from the work of `Leinhardt & Stewart -(2012) `__, and generating the appropriate mass distribution of fragments. Swiftest -fully incorporates collisional fragments into the gravitational system, evolving these new bodies along with pre-existing bodies, including -their growth and any future fragmentation events in which they are involved. +Swiftest is a software packaged designed to model the long-term dynamical dynamics of n-body systems with a dominant central body, +like the solar system. **Useful links**: