added a header and some comments to the fragmentation example

examples/Fragmentation/swiftest_fragmentation.py

@@ -10,29 +10,71 @@
 """
 #!/usr/bin/env python3
 """
-Generates a set of Swiftest input files from initial conditions, runs Swiftest, and generates fragmentation movies.
-Returns
--------
-Updates sim.data with the simulation data, produces fragmentation movies.
+Generates and runs a set of Swiftest input files from initial conditions with the SyMBA integrator. All simulation 
+outputs for the disruption case are stored in the /disruption subdirectory. All simulation outputs for the hit and run 
+case are stored in the /hitandrun subdirectory. All simulation outputs for the super-catastrophic disruption case are 
+stored in the /supercat subdirectory.
+
+Input
+------
+None
+
+Output
+------
+disruption/bin.nc         : A NetCDF file containing the simulation output.
+disruption/dump_bin1.nc   : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
+disruption/dump_bin2.nc   : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
+disruption/dump_param1.in : An ASCII file containing the necessary parameters to restart a simulation.
+disruption/dump_param2.in : An ASCII file containing the necessary parameters to restart a simulation.
+disruption/fraggle.log    : An ASCII file containing the information of any collisional events that occured.
+disruption/init_cond.nc   : A NetCDF file containing the initial conditions for the simulation.
+disruption/param.in       : An ASCII file containing the parameters for the simulation.
+disruption/swiftest.log   : An ASCII file containing the information on the status of the simulation as it runs.
+hitandrun/bin.nc          : A NetCDF file containing the simulation output.
+hitandrun/dump_bin1.nc    : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
+hitandrun/dump_bin2.nc    : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
+hitandrun/dump_param1.in  : An ASCII file containing the necessary parameters to restart a simulation.
+hitandrun/dump_param2.in  : An ASCII file containing the necessary parameters to restart a simulation.
+hitandrun/fraggle.log     : An ASCII file containing the information of any collisional events that occured.
+hitandrun/init_cond.nc    : A NetCDF file containing the initial conditions for the simulation.
+hitandrun/param.in        : An ASCII file containing the parameters for the simulation.
+hitandrun/swiftest.log    : An ASCII file containing the information on the status of the simulation as it runs.
+supercat/bin.nc           : A NetCDF file containing the simulation output.
+supercat/dump_bin1.nc     : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
+supercat/dump_bin2.nc     : A NetCDF file containing the necessary inputs to restart a simulation from t!=0.
+supercat/dump_param1.in   : An ASCII file containing the necessary parameters to restart a simulation.
+supercat/dump_param2.in   : An ASCII file containing the necessary parameters to restart a simulation.
+supercat/fraggle.log      : An ASCII file containing the information of any collisional events that occured.
+supercat/init_cond.nc     : A NetCDF file containing the initial conditions for the simulation.
+supercat/param.in         : An ASCII file containing the parameters for the simulation.
+supercat/swiftest.log     : An ASCII file containing the information on the status of the simulation as it runs.
 """
 import swiftest
 import numpy as np
 from numpy.random import default_rng
 
+# Initialize the simulation object as a variable with arguments.
 sim_disruption = swiftest.Simulation(simdir="disruption", tstart=0.0, tstop=1.0e-5, dt=1.0e-8, istep_out=1.0, fragmentation=True, minimum_fragment_gmass=1.0e-11, gmtiny=1.0e-11, output_file_format="XVEL", init_cond_format="XV")
+# Add the Sun using the JPL Horizons Database.
 sim_disruption.add_solar_system_body(["Sun"])
+# Add a user-defined target body.
 sim_disruption.add_body(name="Target", rh=[[1.0, -1.807993e-05, 0.0]], vh=[[-2.562596e-04, 6.280005, 0.0]], Gmass=1e-7, radius=7e-6, rhill=9e-4, Ip=[[0.4, 0.4, 0.4]], rot=[[0.0, 0.0, 0.0]])
+# Add a user-defined projectile body.
 sim_disruption.add_body(name="Projectile", rh=[[1.0, 1.807993e-05, 0.0]], vh=[[-2.562596e-04, -6.280005, 0.0]], Gmass=7e-10, radius=3.25e-6, rhill=4e-4, Ip=[[0.4, 0.4, 0.4]], rot=[[0.0, 0.0, 0.0]])
+# Display the run configuration parameters.
 sim_disruption.get_parameter()
+# Run the simulation.
 sim_disruption.run()
 
+# Do the same as above for the hit and run case.
 sim_hitandrun = swiftest.Simulation(simdir="hitandrun", tstart=0.0, tstop=1.0e-5, dt=1.0e-8, istep_out=1.0, fragmentation=True, minimum_fragment_gmass=1.0e-11, gmtiny=1.0e-11, output_file_format="XVEL", init_cond_format="XV")
 sim_hitandrun.add_solar_system_body(["Sun"])
 sim_hitandrun.add_body(name="Target", rh=[[1.0, -4.2e-05, 0.0]], vh=[[0.0, 6.28, 0.0]], Gmass=1e-7, radius=7e-6, rhill=9e-4, Ip=[[0.4, 0.4, 0.4]], rot=[[0.0, 0.0, 6.0e4]])
 sim_hitandrun.add_body(name="Projectile", rh=[[1.0, 4.2e-05, 0.0]], vh=[[-1.5, -6.28, 0.0]], Gmass=7e-10, radius=3.25e-6, rhill=4e-4, Ip=[[0.4, 0.4, 0.4]], rot=[[0.0, 0.0, 1.0e5]])
 sim_hitandrun.get_parameter()
 sim_hitandrun.run()
 
+# Do the same as above for the super-catastrophic disruption case.
 sim_supercat = swiftest.Simulation(simdir="supercat", tstart=0.0, tstop=1.0e-5, dt=1.0e-8, istep_out=1.0, fragmentation=True, minimum_fragment_gmass=1.0e-11, gmtiny=1.0e-11, output_file_format="XVEL", init_cond_format="XV")
 sim_supercat.add_solar_system_body(["Sun"])
 sim_supercat.add_body(name="Target", rh=[[1.0, -4.2e-05, 0.0]], vh=[[0.0, 6.28, 0.0]], Gmass=1e-7, radius=7e-6, rhill=9e-4, Ip=[[0.4, 0.4, 0.4]], rot=[[0.0, 0.0, -6.0e4]])