updated more docstring headers

MintonGroup · Feb 10, 2023 · 1c58ffb · 1c58ffb
1 parent bf1b652
commit 1c58ffb
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 13 deletions.
diff --git a/examples/Basic_Simulation/initial_conditions.py b/examples/Basic_Simulation/initial_conditions.py
@@ -21,11 +21,14 @@
 
 Output
 ------
-data.nc        : A NetCDF file containing the simulation output.
-collisions.log : An ASCII file containing the information of any collisional events that occured.
-init_cond.nc   : A NetCDF file containing the initial conditions for the simulation.
-param.in       : An ASCII file containing the parameters for the simulation.
-swiftest.log   : An ASCII file containing the information on the status of the simulation as it runs.
+collisions.log   : An ASCII file containing the information of any collisional events that occured.
+collisions.nc    : A NetCDF file containing the collision output.
+data.nc          : A NetCDF file containing the simulation output.
+init_cond.nc     : A NetCDF file containing the initial conditions for the simulation.
+param.00...0.in  : A series of parameter input files containing the parameters for the simulation at every output stage.
+param.in         : An ASCII file containing the inital parameters for the simulation.
+param.restart.in : An ASCII file containing the parameters for the simulation at the last output. 
+swiftest.log     : An ASCII file containing the information on the status of the simulation as it runs.
 """
 
 import swiftest

diff --git a/examples/Chambers2013/init_cond.py b/examples/Chambers2013/init_cond.py
@@ -21,9 +21,10 @@
 
 Output
 ------
-init_cond.nc   : A NetCDF file containing the initial conditions for the simulation.
-param.in       : An ASCII file containing the parameters for the simulation.
-"""
+inital_conditions.png : A .png file depicting the simulation initial configuration.
+init_cond.nc          : A NetCDF file containing the initial conditions for the simulation.
+param.in              : An ASCII file containing the parameters for the simulation.
+""" 
 
 import swiftest
 import numpy as np

diff --git a/examples/helio_gr_test/helio_gr_test.py b/examples/helio_gr_test/helio_gr_test.py
@@ -30,9 +30,12 @@
 nogr/
 
 Each subdirecotry contains:
+collisions.log               : A NetCDF file containing the collision output.
 data.nc                      : A NetCDF file containing the simulation output.
 init_cond.nc                 : A NetCDF file containing the initial conditions for the simulation.
+param.00...0.in              : A series of parameter input files containing the parameters for the simulation at every output stage.
 param.in                     : An ASCII file containing the parameters for the simulation.
+param.restart.in             : An ASCII file containing the parameters for the simulation at the last output. 
 swiftest.log                 : An ASCII file containing the information on the status of the simulation as it runs.
 """
 

diff --git a/examples/solar_impact/sundiver.py b/examples/solar_impact/sundiver.py
@@ -21,11 +21,14 @@
 
 Output
 ------
-data.nc        : A NetCDF file containing the simulation output.
-collisions.log : An ASCII file containing the information of any collisional events that occured.
-init_cond.nc   : A NetCDF file containing the initial conditions for the simulation.
-param.in       : An ASCII file containing the parameters for the simulation.
-swiftest.log   : An ASCII file containing the information on the status of the simulation as it runs.
+collisions.log   : An ASCII file containing the information of any collisional events that occured.
+collisions.nc    : A NetCDF file containing the collision output.
+data.nc          : A NetCDF file containing the simulation output.
+init_cond.nc     : A NetCDF file containing the initial conditions for the simulation.
+param.00...0.in  : A series of parameter input files containing the parameters for the simulation at every output stage.
+param.in         : An ASCII file containing the parameters for the simulation.
+param.restart.in : An ASCII file containing the parameters for the simulation at the last output. 
+swiftest.log     : An ASCII file containing the information on the status of the simulation as it runs.
 """
 
 import swiftest

diff --git a/examples/whm_gr_test/whm_gr_test.py b/examples/whm_gr_test/whm_gr_test.py
@@ -31,9 +31,12 @@
 nogr/
 
 Each subdirecotry contains:
+collisions.log               : A NetCDF file containing the collision output.
 data.nc                      : A NetCDF file containing the simulation output.
 init_cond.nc                 : A NetCDF file containing the initial conditions for the simulation.
+param.00...0.in              : A series of parameter input files containing the parameters for the simulation at every output stage.
 param.in                     : An ASCII file containing the parameters for the simulation.
+param.restart.in             : An ASCII file containing the parameters for the simulation at the last output. 
 swiftest.log                 : An ASCII file containing the information on the status of the simulation as it runs.
 """