Improved docstrings for many functions in post-processing

PostProcessing/IntegralsPlot.py

@@ -29,9 +29,8 @@ def main():
         IOError: Data path not found
         IOError: Data file not found
         RuntimeError: No plot variables specified
-        SystemError: No plot variables specified
-        SystemError: Number of x limits does not match number of plot variables
-        SystemError: Number of linestyles does not match number of plot variables
+        RuntimeError: Number of linestyles does not match number of plot variables.
+        RuntimeError: Number of xlims does not match number of plot variables.
     """
 
     #Extract basic file information
@@ -55,7 +54,7 @@ def main():
 
     #get the plot variables
     plot_variables = config["VariableData"].get("plot_variables", "").split()
-    if len(plot_variables) == 0:
+    if not plot_variables:
         raise RuntimeError("No plot variables specified.")  
 
 
@@ -66,7 +65,7 @@ def main():
     if linestyles == "":
         linestyles = None
 
-    if not len(linestyles) == len(plot_variables) and linestyles != None:
+    if len(linestyles) != len(plot_variables) and linestyles is not None:
         raise RuntimeError("Number of linestyles does not match number of plot variables.")
 
     # get the x limits
@@ -88,4 +87,3 @@ def main():
     main()
 elif __visit_script_file__ == __visit_source_file__:
     raise RuntimeError("This file should not be run with VisIt, only Python!")
-

PostProcessing/Source/Common/Engine.py

@@ -53,4 +53,3 @@ def setup_engine(config):
 		if not openengine_status:
 			print("Job submission failed. Exiting...")
 			sys.exit(1)
-

PostProcessing/Source/Common/PlotSetup.py

@@ -15,6 +15,9 @@ def Annotation_Setup(config):
 
 	Args:
 		config (configparser.ConfigParser): instance of a ConfigParser class that holds the users parameters
+
+	Raises:
+		RuntimeError: Could not set Annotation attributes. Aborting.
 	"""
 
 	#initialize verbosity printing
@@ -73,6 +76,9 @@ def Pseudocolor_Setup(config, variableToPlot, setplotbounds, plotbounds):
 		variableToPlot (str): name of the variable to be plotted
 		setplotbounds (bool): flag to specify whether bounds for the plotting variable should be specified
 		plotbounds (list): list of two values that specify the minimum and maximum value of the plot variable
+
+	Raises:
+		RuntimeError: Could not set Pseudocolor attributes. Aborting.
 	"""
 
 	#initialize verbosity printing
@@ -130,6 +136,9 @@ def Volume_Setup(config, variableToPlot):
 	Args:
 		config (configparser.ConfigParser): instance of a ConfigParser class that holds the users parameters
 		variableToPlot (str): name of the variable to be plotted
+
+	Raises:
+		RuntimeError: Could not set Volume attributes. Aborting.
 	"""
 
 	#initialize verbosity printing
@@ -205,6 +214,9 @@ def SliceAttribute_Setup(config):
 
 	Args:
 		config (configparser.ConfigParser): instance of a ConfigParser class that holds the users parameters
+
+	Raises:
+		RuntimeError: Could not set slice attributes. Aborting.
 	"""
 
 	#initialize verbosity printing
@@ -264,6 +276,9 @@ def Mesh_Setup(config):
 
 	Args:
 		config (configparser.ConfigParser): instance of a ConfigParser class that holds the users parameters
+
+	Raises:
+		RuntimeError: Could not set mesh attributes. Aborting.
 	"""
 
 	#initialize verbosity printing
@@ -292,6 +307,9 @@ def View_2D_Setup(config):
 
 	Args:
 		config (configparser.ConfigParser): instance of a ConfigParser class that holds the users parameters
+
+	Raises:
+		RuntimeError: Failed to set 2D view.
 	"""
 
 	#initialize verbosity printing
@@ -338,7 +356,7 @@ def View_2D_Setup(config):
 	#set the above view attributes
 	status = visit.SetView2D(View2DAtts)	
 
-	if not status:	
+	if not status:
 		raise RuntimeError("Failed to set 2D view")
 
 	return status
@@ -349,6 +367,9 @@ def View_3D_Setup(config):
 
 	Args:
 		config (configparser.ConfigParser): instance of a ConfigParser class that holds the users parameters
+
+	Raises:
+		RuntimeError: Failed to set 3D view.
 	"""
 
 	#initialize verbosity printing
@@ -382,7 +403,7 @@ def View_3D_Setup(config):
 	#set the above view attributes
 	status = visit.SetView3D(View3DAtts)
 
-	if not status:	
+	if not status:
 		raise RuntimeError("Failed to set 3D view")
 
 	return status
@@ -451,4 +472,3 @@ def Save_Current_Window(config, variableToPlot):
 	status = visit.SaveWindow()
 
 	return status
-

PostProcessing/Source/Common/Plotter.py

@@ -19,7 +19,6 @@ def make_visit_plot(config, variableToPlot, hdf5files, plot_type = '2d', setplot
 		plotbounds (list, optional): list of two values that specify the minimum and maximum value of the plot variable. Defaults to [0,1].
 
 	Raises:
-		IOError: Database could not be opened
 		RuntimeError: TimeSlider could not advance
 		RuntimeError: Window could not be saved
 		SystemError: Plot could not be cleared from memory
@@ -83,8 +82,3 @@ def make_visit_plot(config, variableToPlot, hdf5files, plot_type = '2d', setplot
 	plotdelete_status = visit.DeleteAllPlots()
 	if not plotdelete_status:
 		raise SystemError("Plot could not be deleted!")
-
-
-
-
-

PostProcessing/Source/Common/Utils.py

@@ -213,6 +213,17 @@ def Open_Database(config):
 
 @require_visit
 def Close_Database(config):
+    """Close a VisIt database object
+
+    Args:
+		config (configparser.ConfigParser): instance of a ConfigParser class that holds the users parameters
+
+    Raises:
+        IOError: Could not close database!
+
+    Returns:
+        int: status code of closing database
+    """
 
     if MultipleDatabase(config):
         filename_prefix = os.path.join(config["Header"]["hdf5_path"], config["Header"]["plot_header"])
@@ -311,6 +322,15 @@ def save_pyplot_fig(config, varname):
 
 
 def make_movie(config, plotvariable):
+    """Generates movie using ffmpeg from a series of images
+
+    Args:
+		config (configparser.ConfigParser): instance of a ConfigParser class that holds the users parameters
+        plotvariable (str): name of the variable to be plotted
+
+    Raises:
+        OSError: ffmpeg failed. Could not make the movie. 
+    """
 
     make_movie = config["Output"].getint("make_movie", fallback = 0)
 

PostProcessing/Source/OneD/LinePlot.py

@@ -82,4 +82,3 @@ def make_plots(config, data_obj, plot_variables, plotbounds = None,  linestyles
         plt.legend()
         plt.ylabel("") #remove ylabel for combined plot
         save_pyplot_fig(config, "combined")
-

PostProcessing/VisitPlot.py

@@ -31,7 +31,7 @@ def main():
 	"""main function to run VisIt plot routines
 
 	Raises:
-		OSError: ffmpeg failed. Could not make the movie.
+		RuntimeError: No plot variables specified!
 	"""
 
 	# get list of all hdf5 plot files
@@ -40,8 +40,8 @@ def main():
 
 	# get list of plot variables
 	plot_variables = config["VariableData"].get("plot_variables", "").split()
-	if len(plot_variables) == 0:
-		raise SystemError("No plot variables specified!")
+	if not plot_variables:
+		raise RuntimeError("No plot variables specified!")
 
 	verbPrint("Number of plot variables: ", len(plot_variables))
 	verbPrint("Variables to be plotted: ", config["VariableData"].get("plot_variables", ""))