fixed naming conventions and removed outdated files from header docum…

…entation in python scripts
MintonGroup · Feb 9, 2023 · 2752fd7 · 2752fd7
1 parent 8d9b37f
commit 2752fd7
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 31 deletions.
diff --git a/examples/Basic_Simulation/initial_conditions.py b/examples/Basic_Simulation/initial_conditions.py
@@ -21,12 +21,8 @@
 
 Output
 ------
-data.nc         : A NetCDF file containing the simulation output.
-dump_bin1.nc   : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
-dump_bin2.nc   : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
-dump_param1.in : An ASCII file containing the necessary parameters to restart a simulation.
-dump_param2.in : An ASCII file containing the necessary parameters to restart a simulation.
-fraggle.log    : An ASCII file containing the information of any collisional events that occured.
+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.

diff --git a/examples/Fragmentation/Fragmentation_Movie.py b/examples/Fragmentation/Fragmentation_Movie.py
@@ -15,15 +15,12 @@
 
 Inputs
 _______
-param.in : ASCII text file
-    Swiftest parameter input file.
-out.nc   : NetCDF file
-    Swiftest output file.
+param.in    : ASCII Swiftest parameter input file.
+data.nc     : A NetCDF file containing the simulation output.
 
 Returns
 -------
-fragmentation.mp4 : mp4 movie file
-    Movie of a fragmentation event.
+fragmentation.mp4 : A .mp4 file of a fragmentation event.
 """
 
 import swiftest

diff --git a/examples/Fragmentation/Multibody_Movie.py b/examples/Fragmentation/Multibody_Movie.py
@@ -15,15 +15,12 @@
 
 Inputs
 _______
-param.in : ASCII text file
-    Swiftest parameter input file.
-out.nc   : NetCDF file
-    Swiftest output file.
+param.in    : ASCII Swiftest parameter input file.
+data.nc     : A NetCDF file containing the simulation output.
 
 Returns
 -------
-fragmentation.mp4 : mp4 movie file
-    Movie of a fragmentation event.
+fragmentation.mp4 : A .mp4 file of a fragmentation event.
 """
 
 import swiftest

diff --git a/examples/Fragmentation/swiftest_fragmentation.py b/examples/Fragmentation/swiftest_fragmentation.py
@@ -33,11 +33,7 @@
 init_cond.nc        : A NetCDF file containing the initial conditions for the simulation.
 collision_000001.nc : A NetCDF file containing the data for the collisions.
 encounter_000001.nc : A NetCDF file containing the data for the close encounters.
-dump_bin1.nc        : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
-dump_bin2.nc        : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
-dump_param1.in      : An ASCII file containing the necessary parameters to restart a simulation.
-dump_param2.in      : An ASCII file containing the necessary parameters to restart a simulation.
-fraggle.log         : An ASCII file containing the information of any collisional events that occured.
+collisions.log      : An ASCII file containing the information of any collisional events that occured.
 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.
 

diff --git a/examples/helio_gr_test/helio_gr_test.py b/examples/helio_gr_test/helio_gr_test.py
@@ -31,11 +31,7 @@
 
 Each subdirecotry contains:
 data.nc                      : A NetCDF file containing the simulation output.
-dump_bin1.nc                 : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
-dump_bin2.nc                 : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
 init_cond.nc                 : A NetCDF file containing the initial conditions for the simulation.
-dump_param1.in               : An ASCII file containing the necessary parameters to restart a simulation.
-dump_param2.in               : An ASCII file containing the necessary parameters to restart a 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.
 """

diff --git a/examples/whm_gr_test/whm_gr_test.py b/examples/whm_gr_test/whm_gr_test.py
@@ -32,11 +32,7 @@
 
 Each subdirecotry contains:
 data.nc                      : A NetCDF file containing the simulation output.
-dump_bin1.nc                 : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
-dump_bin2.nc                 : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
 init_cond.nc                 : A NetCDF file containing the initial conditions for the simulation.
-dump_param1.in               : An ASCII file containing the necessary parameters to restart a simulation.
-dump_param2.in               : An ASCII file containing the necessary parameters to restart a 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.
 """