created header documentation for python scripts that were missing it

MintonGroup · Feb 9, 2023 · c5d210e · c5d210e
1 parent 2752fd7
commit c5d210e
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 0 deletions.
diff --git a/examples/Chambers2013/init_cond.py b/examples/Chambers2013/init_cond.py
@@ -12,6 +12,19 @@
 """
 
 """
+Generates a set of Swiftest input files from initial conditions with the SyMBA integrator. All simulation 
+outputs are stored in the /simdata subdirectory.
+
+Input
+------
+None.
+
+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.
+"""
+
 import swiftest
 import numpy as np
 from numpy.random import default_rng

diff --git a/examples/Chambers2013/scattermovie.py b/examples/Chambers2013/scattermovie.py
@@ -12,6 +12,21 @@
 """
 
 """
+Creates a movie from a set of Swiftest output files. All simulation 
+outputs are stored in the /simdata subdirectory.
+
+Input
+------
+param.in    : ASCII Swiftest parameter input file.
+data.nc     : A NetCDF file containing the simulation output.
+
+Output
+------
+Chambers2013-aescatter.mp4  : A .mp4 file plotting eccentricity vs semimajor axis. 
+OR 
+Chambers2013-aiscatter.mp4  : A .mp4 file plotting inclination vs semimajor axis. 
+"""
+
 import swiftest 
 import numpy as np
 import matplotlib.pyplot as plt

diff --git a/examples/Swifter_Swiftest/8pl_0tp/init_cond.py b/examples/Swifter_Swiftest/8pl_0tp/init_cond.py
@@ -12,6 +12,25 @@
 """
 
 """
+Generates and runs a set of Swiftest input files and a set of Swifter input files from initial conditions with the 
+SyMBA integrator. 
+
+Input
+------
+None.
+
+Output
+------
+param.swiftest.in      : An ASCII file containing the parameters for the Swiftest simulation.
+param.swifter.in       : An ASCII file containing the parameters for the Swifter simulation.
+cb.swiftest.in         : An ASCII file containing the central body data for the Swiftest simulation.
+pl.swifter.in          : An ASCII file containing the massive body data for the Swifter simulation.
+pl.swiftest.in         : An ASCII file containing the massive body data for the Swiftest simulation.
+tp.swifter.in          : An ASCII file containing the test particle data for the Swifter simulation.
+tp.swiftest.in         : An ASCII file containing the test particle data for the Swiftest simulation.
+
+"""
+
 import numpy as np
 import swiftest
 import swiftest.io as swio

diff --git a/examples/solar_impact/sundiver.py b/examples/solar_impact/sundiver.py
@@ -12,6 +12,22 @@
 """
 
 """
+Generates and runs a set of Swiftest input files from initial conditions with the SyMBA integrator. All simulation 
+outputs are stored in the /simdata subdirectory.
+
+Input
+------
+None.
+
+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.
+"""
+
 import swiftest
 import numpy as np