diff --git a/docs/getting-started-guide/index.rst b/docs/getting-started-guide/index.rst index 04fdb55f2..ffd227144 100644 --- a/docs/getting-started-guide/index.rst +++ b/docs/getting-started-guide/index.rst @@ -615,39 +615,15 @@ The number and type of output files generated by Swiftest depends on the input parameters selected and the method through which Swiftest was run. The standard output files are as follows: -- **data.nc** - Always -generated, the output file containing the information for every body in -the system, recorded every ``ISTEP_OUT`` timesteps and written every -``DUMP_CADENCE``. This file can be analyzed using the Swiftest Python -package (``sim.data``). -- **collisions.log** - The log containing the -record of each fragmentation event, including the collisional regime, -and the number of the fragments created, only if ``FRAGMENTATION`` is -``YES``, Swiftest SyMBA only. - **swiftest.log** - A log containing a -brief update on the status of the run. Only generated if Swiftest is run -through the Python package or through a shell script. If Swiftest is run -through an executable, these updates are output directly to the -terminal. - **collisions.nc** - The details of each collision that -occurs in a simulation are recorded in a NetCDF file. Only if -``CHK_CLOSE``/``close_encounter_check`` is ``YES``/``True``. This file -can be analyzed using the Swiftest Python package (``sim.collisions``). -- **encounters.nc** - The details of each close encounter that occurs in -a simulation are recorded in a NetCDF file. Only if -``CHK_CLOSE``/``close_encounter_check`` is ``YES``/``True``. This file -can be analyzed using the Swiftest Python package (``sim.encounters``). -- **init_cond.nc** - The initial conditions used to run the simulation. -This file can be analyzed using the Swiftest Python package -(``sim.init_cond``). - **encounter_check_plpl_timer.log** - The log -containing the encounter check timer for each massive body/massive body -encounter, only if ``CHK_CLOSE``/``close_encounter_check`` is -``YES``/``True`` and ``ENCOUNTER_CHECK``/``encounter_check_loops`` is -``ADAPTIVE``. - **encounter_check_pltp_time.log** - The log containing -the encounter check timer for each massive body/test particle encounter, -only if ``CHK_CLOSE``/``close_encounter_check`` is ``YES``/``True`` and -``ENCOUNTER_CHECK``/``encounter_check_loops`` is ``ADAPTIVE``. - -**interaction_timer.log** - The log containing the interaction loop -timer for each interacting pair of bodies, only if ``INTERACTION_LOOPS`` -is ``ADAPTIVE``. +- **data.nc** - Always generated, the output file containing the information for every body in the system, recorded every ``ISTEP_OUT`` timesteps and written every ``DUMP_CADENCE``. This file can be analyzed using the Swiftest Python package (``sim.data``). +- **collisions.log** - The log containing the record of each fragmentation event, including the collisional regime, and the number of the fragments created, only if ``FRAGMENTATION`` is ``YES``, Swiftest SyMBA only. +- **swiftest.log** - A log containing a brief update on the status of the run. Only generated if Swiftest is run through the Python package or through a shell script. If Swiftest is run through an executable, these updates are output directly to the terminal. +- **collisions.nc** - The details of each collision that occurs in a simulation are recorded in a NetCDF file. Only if ``CHK_CLOSE``/``close_encounter_check`` is ``YES``/``True``. This file can be analyzed using the Swiftest Python package (``sim.collisions``). +- **encounters.nc** - The details of each close encounter that occurs in a simulation are recorded in a NetCDF file. Only if ``CHK_CLOSE``/``close_encounter_check`` is ``YES``/``True``. This file can be analyzed using the Swiftest Python package (``sim.encounters``). +- **init_cond.nc** - The initial conditions used to run the simulation. This file can be analyzed using the Swiftest Python package (``sim.init_cond``). +- **encounter_check_plpl_timer.log** - The log containing the encounter check timer for each massive body/massive body encounter, only if ``CHK_CLOSE``/``close_encounter_check`` is ``YES``/``True`` and ``ENCOUNTER_CHECK``/``encounter_check_loops`` is ``ADAPTIVE``. +- **encounter_check_pltp_time.log** - The log containing the encounter check timer for each massive body/test particle encounter, only if ``CHK_CLOSE``/``close_encounter_check`` is ``YES``/``True`` and ``ENCOUNTER_CHECK``/``encounter_check_loops`` is ``ADAPTIVE``. +- **interaction_timer.log** - The log containing the interaction loop timer for each interacting pair of bodies, only if ``INTERACTION_LOOPS`` is ``ADAPTIVE``. To read in a Swiftest output file, simply create a new Python script in the simulation directory.