Rename parameters 'omit_from_shp' -> 'omit', and 'plot_stats' -> 'disagnostics'

probabilistic-analysis/probabilistic_assessment.py

@@ -335,7 +335,7 @@ def get_storm_demand_volume(ref_aep, ref_vol, n, mode='fit'):
 def process(beach_name, beach_scenario, n_runs, start_year, end_year,
             output_years, output_ep, zsa_profile_file, zrfc_profile_file,
             output_folder, figure_folder, sea_level_rise, bruun_factor,
-            underlying_recession, storm_demand, plot_stats, omit_from_shp,
+            underlying_recession, storm_demand, diagnostics, omit,
             min_chainage, segment_gaps, insert_points, append_points):
     """
     Calculate probabilistic shorelines using Monte Carlo simulation
@@ -364,19 +364,19 @@ def process(beach_name, beach_scenario, n_runs, start_year, end_year,
             'min'  (float): minimum value
             'mode' (float): most likely value
             'max'  (float): maximum value
-        plot_stats (dict):
-            'block'   (list): block id for plotting stats
-            'profile' (list): profile id for plotting stats
-        omit_from_shp (dict):
-            'block'   (list): block id for plotting stats
-            'profile' (list): profile id for plotting stats
+        diagnostics (dict):
+            'block'   (list): block IDs for outputting diagnostics
+            'profile' (list): profile IDs for outputting diagnostics
+        omit (dict):
+            'block'   (list): block IDs to omit from analysis
+            'profile' (list): profile IDs to omit from analysis
         min_chainage (dict):
-            'block'    (list): block id for trimming chainage
-            'profile'  (list): profile id for trimming chainage
+            'block'    (list): block IDs for trimming chainage
+            'profile'  (list): profile IDs for trimming chainage
             'chainage' (list): minimum chainage, at non-erodable barrier
         segment_gaps (dict):
-            'block'    (list): block id for breaking segment
-            'profile'  (list): profile id for breaking segments
+            'block'    (list): block IDs for breaking segment
+            'profile'  (list): profile IDs for breaking segments
         insert_points (dict):
             'before' (dict): points to add to (south/west) end of hazard lines
                 'x'  (list): eastings
@@ -575,7 +575,7 @@ def process(beach_name, beach_scenario, n_runs, start_year, end_year,
                     df_csv.loc[[], :].to_csv(csv_name, index=False)
 
                 # Only save points if they are going into shapefile
-                df_csv = df_csv[~df_csv['omit_from_shp'].astype(bool)]
+                df_csv = df_csv[~df_csv['omit'].astype(bool)]
 
                 # Append data for current profile
                 df_csv[df_csv.index == i].to_csv(csv_name,