spec.yaml

id: events
requirements:
  - name: ecoscope-workflows-core
    version: 0.1.5
    channel: https://repo.prefix.dev/ecoscope-workflows/
  - name: ecoscope-workflows-ext-ecoscope
    version: 0.1.5
    channel: https://repo.prefix.dev/ecoscope-workflows/
rjsf-overrides:
  properties:
    get_events_data.properties.event_types.ecoscope:event_type: properties.er_client_name.properties.data_source.properties.name
  $defs:
    ValueGrouper.oneOf:
      - const: event_category
        title: Event Category
      - const: event_type
        title: Event Type
      - const: reported_by_name
        title: Reported By Name
workflow:
  - name: Workflow Details
    id: workflow_details
    task: set_workflow_details
  - name: Data Source
    id: er_client_name
    task: set_er_connection
  - name: Time Range
    id: time_range
    task: set_time_range
    partial:
      time_format: '%d %b %Y %H:%M:%S %Z'
  - name: Get Events from EarthRanger
    id: get_events_data
    task: get_events
    partial:
      client: ${{ workflow.er_client_name.return }}
      time_range: ${{ workflow.time_range.return }}
      event_columns:
        - id
        - time
        - event_type
        - event_category
        - reported_by
        - serial_number
        - geometry
      raise_on_empty: true
  - name: Extract reported_by_name from Events
    id: extract_reported_by
    task: extract_value_from_json_column
    partial:
      df: ${{ workflow.get_events_data.return }}
      column_name: reported_by
      field_name_options:
        - name
      output_type: str
      output_column_name: reported_by_name
  - name: Group Data
    id: groupers
    task: set_groupers
  - name: Apply Relocation Coordinate Filter
    id: filter_events
    task: apply_reloc_coord_filter
    partial:
      df: ${{ workflow.extract_reported_by.return }}
      roi_gdf: null
      roi_name: null
  - name: Add temporal index to Events
    id: events_add_temporal_index
    task: add_temporal_index
    partial:
      df: ${{ workflow.filter_events.return }}
      time_col: time
      groupers: ${{ workflow.groupers.return }}
      cast_to_datetime: true
      format: mixed
  - name: Events Colormap
    id: events_colormap
    task: apply_color_map
    partial:
      df: ${{ workflow.events_add_temporal_index.return }}
      input_column_name: event_type
      colormap: tab20b
      output_column_name: event_type_colormap
  - name: Split Events by Group
    id: split_event_groups
    task: split_groups
    partial:
      df: ${{ workflow.events_colormap.return }}
      groupers: ${{ workflow.groupers.return }}
  - name: Draw Time Series Bar Chart for Events
    id: events_bar_chart
    task: draw_time_series_bar_chart
    partial:
      x_axis: time
      y_axis: event_type
      category: event_type
      agg_function: count
      color_column: event_type_colormap
      plot_style:
        xperiodalignment: middle
      grouped_styles: null
      layout_style: null
    mapvalues:
      argnames: dataframe
      argvalues: ${{ workflow.split_event_groups.return }}
  - name: Persist Bar Chart as Text
    id: events_bar_chart_html_url
    task: persist_text
    partial:
      root_path: ${{ env.ECOSCOPE_WORKFLOWS_RESULTS }}
    mapvalues:
      argnames: text
      argvalues: ${{ workflow.events_bar_chart.return }}
  - name: Create Bar Plot Widget for Events
    id: events_bar_chart_widget
    task: create_plot_widget_single_view
    partial:
      title: Events Bar Chart
    map:
      argnames:
        - view
        - data
      argvalues: ${{ workflow.events_bar_chart_html_url.return }}
  - name: Merge Bar Plot Widget Views
    id: grouped_bar_plot_widget_merge
    task: merge_widget_views
    partial:
      widgets: ${{ workflow.events_bar_chart_widget.return }}
  - name: Rename columns for map tooltip display
    id: rename_display_columns
    task: map_columns
    partial:
      drop_columns: []
      retain_columns: []
      rename_columns:
        serial_number: Event Serial
        time: Event Time
        event_type: Event Type
        reported_by_name: Reported By
    mapvalues:
      argnames: df
      argvalues: ${{ workflow.split_event_groups.return }}
  - name: Base Maps
    id: base_map_defs
    task: set_base_maps
  - name: Create map layer from grouped Events
    id: grouped_events_map_layer
    task: create_point_layer
    partial:
      layer_style:
        fill_color_column: event_type_colormap
        get_radius: 5
      legend:
        label_column: Event Type
        color_column: event_type_colormap
      tooltip_columns:
        - Event Serial
        - Event Time
        - Event Type
        - Reported By
    mapvalues:
      argnames: geodataframe
      argvalues: ${{ workflow.rename_display_columns.return }}
  - name: Draw Ecomap from grouped Events
    id: grouped_events_ecomap
    task: draw_ecomap
    partial:
      title: null
      tile_layers: ${{ workflow.base_map_defs.return }}
      north_arrow_style:
        placement: top-left
      legend_style:
        placement: bottom-right
      static: false
      max_zoom: 20
    mapvalues:
      argnames: geo_layers
      argvalues: ${{ workflow.grouped_events_map_layer.return }}
  - name: Persist grouped Events Ecomap as Text
    id: grouped_events_ecomap_html_url
    task: persist_text
    partial:
      root_path: ${{ env.ECOSCOPE_WORKFLOWS_RESULTS }}
    mapvalues:
      argnames: text
      argvalues: ${{ workflow.grouped_events_ecomap.return }}
  - name: Create grouped Events Map Widget
    id: grouped_events_map_widget
    task: create_map_widget_single_view
    partial:
      title: Events Map
    map:
      argnames:
        - view
        - data
      argvalues: ${{ workflow.grouped_events_ecomap_html_url.return }}
  - name: Merge Events Map Widget Views
    id: grouped_events_map_widget_merge
    task: merge_widget_views
    partial:
      widgets: ${{ workflow.grouped_events_map_widget.return }}
  - name: Draw Pie Chart for Events
    id: grouped_events_pie_chart
    task: draw_pie_chart
    partial:
      value_column: event_type
      color_column: event_type_colormap
      plot_style:
        textinfo: value
      label_column: null
      layout_style: null
    mapvalues:
      argnames: dataframe
      argvalues: ${{ workflow.split_event_groups.return }}
  - name: Persist Pie Chart as Text
    id: grouped_pie_chart_html_urls
    task: persist_text
    partial:
      root_path: ${{ env.ECOSCOPE_WORKFLOWS_RESULTS }}
    mapvalues:
      argnames: text
      argvalues: ${{ workflow.grouped_events_pie_chart.return }}
  - name: Create Plot Widget for Events
    id: grouped_events_pie_chart_widgets
    task: create_plot_widget_single_view
    partial:
      title: Events Pie Chart
    map:
      argnames:
        - view
        - data
      argvalues: ${{ workflow.grouped_pie_chart_html_urls.return }}
  - name: Merge Pie Chart Widget Views
    id: grouped_events_pie_widget_merge
    task: merge_widget_views
    partial:
      widgets: ${{ workflow.grouped_events_pie_chart_widgets.return }}
  - name: Create Events Meshgrid
    id: events_meshgrid
    task: create_meshgrid
    partial:
      aoi: ${{ workflow.events_add_temporal_index.return }}
      intersecting_only: false
  - name: Grouped Events Feature Density
    id: grouped_events_feature_density
    task: calculate_feature_density
    partial:
      meshgrid: ${{ workflow.events_meshgrid.return }}
      geometry_type: point
    mapvalues:
      argnames: geodataframe
      argvalues: ${{ workflow.split_event_groups.return }}
  - name: Grouped Feature Density Colormap
    id: grouped_fd_colormap
    task: apply_color_map
    partial:
      input_column_name: density
      colormap: RdYlGn_r
      output_column_name: density_colormap
    mapvalues:
      argnames: df
      argvalues: ${{ workflow.grouped_events_feature_density.return }}
  - name: Sort Density By Classification
    id: sort_grouped_density_values
    task: sort_values
    partial:
      column_name: density
      ascending: true
      na_position: last
    mapvalues:
      argnames: df
      argvalues: ${{ workflow.grouped_fd_colormap.return }}
  - name: Format Grouped Feature Density Labels
    id: grouped_feature_density_format
    task: map_values_with_unit
    partial:
      original_unit: null
      new_unit: null
      input_column_name: density
      output_column_name: density
      decimal_places: 0
    mapvalues:
      argnames: df
      argvalues: ${{ workflow.sort_grouped_density_values.return }}
  - name: Create map layer from Feature Density
    id: grouped_fd_map_layer
    task: create_polygon_layer
    partial:
      layer_style:
        fill_color_column: density_colormap
        get_line_width: 0
        opacity: 0.400000
      legend:
        label_column: density
        color_column: density_colormap
      tooltip_columns:
        - density
    mapvalues:
      argnames: geodataframe
      argvalues: ${{ workflow.grouped_feature_density_format.return}}
  - name: Draw Ecomap from Feature Density
    id: grouped_fd_ecomap
    task: draw_ecomap
    partial:
      title: null
      tile_layers: ${{ workflow.base_map_defs.return }}
      north_arrow_style:
        placement: top-left
      legend_style:
        title: Number of events
        placement: bottom-right
      static: false
      max_zoom: 20
    mapvalues:
      argnames: geo_layers
      argvalues: ${{ workflow.grouped_fd_map_layer.return }}
  - name: Persist Feature Density Ecomap as Text
    id: grouped_fd_ecomap_html_url
    task: persist_text
    partial:
      root_path: ${{ env.ECOSCOPE_WORKFLOWS_RESULTS }}
    mapvalues:
      argnames: text
      argvalues: ${{ workflow.grouped_fd_ecomap.return }}
  - name: Create Feature Density Map Widget
    id: grouped_fd_map_widget
    task: create_map_widget_single_view
    partial:
      title: Density Map
    map:
      argnames:
        - view
        - data
      argvalues: ${{ workflow.grouped_fd_ecomap_html_url.return }}
  - name: Merge Feature Density Widget Views
    id: grouped_fd_map_widget_merge
    task: merge_widget_views
    partial:
      widgets: ${{ workflow.grouped_fd_map_widget.return }}
  - name: Create Dashboard with Map Widgets
    id: events_dashboard
    task: gather_dashboard
    partial:
      details: ${{ workflow.workflow_details.return}}
      widgets:
        - ${{ workflow.grouped_bar_plot_widget_merge.return }}
        - ${{ workflow.grouped_events_map_widget_merge.return }}
        - ${{ workflow.grouped_events_pie_widget_merge.return }}
        - ${{ workflow.grouped_fd_map_widget_merge.return }}
      groupers: ${{ workflow.groupers.return }}
      time_range: ${{ workflow.time_range.return}}