:py:mod:`gnome.outputters.erma_data_package`
============================================

.. py:module:: gnome.outputters.erma_data_package

.. autoapi-nested-parse::

   ERMA Data Package outputter



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   gnome.outputters.erma_data_package.ERMADataPackageOutput




.. py:class:: ERMADataPackageOutput(filename, folder_name=None, certain_layer_name=None, include_certain_particles=True, uncertain_layer_name=None, include_uncertain_particles=True, certain_boundary_layer_name=None, include_certain_boundary=False, certain_boundary_separate_by_spill=True, certain_boundary_hull_ratio=0.5, certain_boundary_hull_allow_holes=False, certain_boundary_color=None, certain_boundary_size=None, certain_contours_layer_name=None, include_certain_contours=False, certain_contours_hull_ratio=0.5, certain_contours_hull_allow_holes=False, certain_contours_size=None, uncertain_boundary_layer_name=None, include_uncertain_boundary=True, uncertain_boundary_separate_by_spill=True, uncertain_boundary_hull_ratio=0.5, uncertain_boundary_hull_allow_holes=False, uncertain_boundary_color=None, uncertain_boundary_size=None, map_bounds_layer_name=None, include_map_bounds=False, map_bounds_color=None, map_bounds_size=None, spillable_area_layer_name=None, include_spillable_area=False, spillable_area_color=None, spillable_area_size=None, land_polys_layer_name=None, include_land_polys=False, land_polys_color=None, land_polys_size=None, include_spill_location=True, disable_legend_collapse=False, time_step_override=None, time_unit_override=None, surface_conc='kde', **kwargs)


   Bases: :py:obj:`gnome.outputters.outputter.Outputter`

   Outputs the GNOME results as shapefile, and then wraps in an
   ERMA data package.

   :param filename: Full path and filename (with ext) of the desired outout file
   :param surface_conc="kde": method to use to compute surface concentration
                              current options are: 'kde' and None

   .. py:attribute:: _schema

      

   .. py:attribute:: time_formatter
      :value: '%m/%d/%Y %H:%M'

      

   .. py:method:: __del__()


   .. py:method:: prepare_for_model_run(model_start_time, spills, uncertain=False, **kwargs)

      Setup before we run the model. 


   .. py:method:: write_output(step_num, islast_step=False)

      Dump a timestep's data into the shapefile 


   .. py:method:: post_model_run()

      The final step to wrap everything up 


   .. py:method:: build_package()


   .. py:method:: make_contour_polygon_package_layer(id, shapefile_filename, layer_title, style_name, style_width)


   .. py:method:: make_boundary_polygon_package_layer(id, uncertain, shapefile_filename, layer_title, style_name, color, style_width)


   .. py:method:: make_map_polygon_package_layer(id, map_polygon_name, shapefile_name, layer_title, style_name, color, style_width)


   .. py:method:: make_spill_location_package_layer(id)


   .. py:method:: spills_match_style(spill1, spill2)


   .. py:method:: group_like_spills()


   .. py:method:: generate_cutoff_struct()


   .. py:method:: make_particle_package_layer(id, layer_name, uncertain, shapefile_filename)


   .. py:method:: rewind()

      reset a few parameter and call base class rewind to reset
      internal variables.


   .. py:method:: clean_output_files()

      deletes ouput files that may be around
      called by prepare_for_model_run
      here in case it needs to be called from elsewhere