compute
=======

.. py:module:: compute


Functions
---------

.. autoapisummary::

   compute._write_result_to_csv
   compute.get_carrier_churn_lanes
   compute.get_contract_weight
   compute.get_corridor_candidates
   compute.get_corridor_oppys
   compute.get_dashboard_kpis
   compute.get_dat_trend_rolling
   compute.get_final_candidate_total_alloc
   compute.get_flex_candidates
   compute.get_flex_oppys
   compute.get_forecast_day_cutoff
   compute.get_high_spend_vol_lanes
   compute.get_high_vol_lanes
   compute.get_kma_markets
   compute.get_lane_daily_loads
   compute.get_load_actual_mkt_lh
   compute.get_load_dat_lh
   compute.get_load_dat_trend
   compute.get_load_pga_revenue
   compute.get_loads_mkt
   compute.get_mkt_18mo_max_rpm
   compute.get_mkt_18mo_mean_rpm
   compute.get_mkt_current_rpm
   compute.get_mkt_max_mean
   compute.get_network_candidates
   compute.get_network_oppys
   compute.get_oppy_metrics
   compute.get_origin_risk
   compute.get_overall_spend_variability
   compute.get_power_lane_annual_lh_loads
   compute.get_power_lane_fleet_type
   compute.get_power_lane_name
   compute.get_risk_metrics
   compute.get_rpm_trend_w_fcst
   compute.get_ship_rate_day_cutoff
   compute.get_spend_variability_breakdown
   compute.get_spot_weight
   compute.get_top_lanes
   compute.get_total_daily_revenue
   compute.get_total_spend_trend_w_fcst
   compute.get_total_variability
   compute.get_trip_type_weighting
   compute.get_window_start_date


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

.. py:function:: _write_result_to_csv(result: pandas.DataFrame, file_name: str)

.. py:function:: get_carrier_churn_lanes(gtm_loads: pandas.DataFrame, window_start_date: datetime.datetime) -> pandas.DataFrame

.. py:function:: get_contract_weight(spot_weight: float) -> float

.. py:function:: get_corridor_candidates(load_dat_lh: pandas.DataFrame, corridors: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_corridor_oppys(corridor_candidates: pandas.DataFrame, power_lane_annual_lh_loads: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_dashboard_kpis(load_actual_mkt_lh: pandas.DataFrame, window_start_date: datetime.datetime, pga_loads: pandas.DataFrame, load_dat_lh: pandas.DataFrame, overall_spend_variability: float, total_variability: float, total_daily_revenue: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_dat_trend_rolling(dat_trend: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_final_candidate_total_alloc(load_dat_lh: pandas.DataFrame, corridor_candidates: pandas.DataFrame, flex_candidates: pandas.DataFrame, network_candidates: pandas.DataFrame, power_lane_fleet_type: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_flex_candidates(lane_quick_ref: pandas.DataFrame, load_dat_lh: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_flex_oppys(flex_candidates: pandas.DataFrame, power_lane_annual_lh_loads: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_forecast_day_cutoff() -> int

.. py:function:: get_high_spend_vol_lanes(load_actual_mkt_lh: pandas.DataFrame, window_start_date: datetime.datetime, power_lane_name: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_high_vol_lanes(power_lane_load_vol: pandas.DataFrame, lane_daily_loads: pandas.DataFrame, load_actual_mkt_lh: pandas.DataFrame, power_lane_name: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_kma_markets() -> pandas.DataFrame

.. py:function:: get_lane_daily_loads(load_dat_lh: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_load_actual_mkt_lh(power_lane_fleet_type: pandas.DataFrame, load_dat_trend: pandas.DataFrame, load_dat_lh: pandas.DataFrame, dat_trend: pandas.DataFrame, window_start_date: datetime.datetime, spot_weight: float, contract_weight: float) -> pandas.DataFrame

.. py:function:: get_load_dat_lh(dat_table: pandas.DataFrame, kma_markets: pandas.DataFrame, loads_mkt: pandas.DataFrame, ship_rate_day_cutoff: int) -> pandas.DataFrame

.. py:function:: get_load_dat_trend(dat_trend_rolling: pandas.DataFrame, load_dat_lh: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_load_pga_revenue(load_dat_lh: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_loads_mkt(gtm_loads: pandas.DataFrame, kma_markets: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_mkt_18mo_max_rpm(dat_trend_rolling: pandas.DataFrame, trip_type_weighting: pandas.DataFrame, contract_weight: float, spot_weight: float) -> float

.. py:function:: get_mkt_18mo_mean_rpm(dat_trend_rolling: pandas.DataFrame, trip_type_weighting: pandas.DataFrame, contract_weight: float, spot_weight: float) -> float

.. py:function:: get_mkt_current_rpm(dat_trend_rolling: pandas.DataFrame, trip_type_weighting: pandas.DataFrame, contract_weight: float, spot_weight: float) -> float

.. py:function:: get_mkt_max_mean(load_dat_lh: pandas.DataFrame, mkt_18mo_mean_rpm: float, mkt_18mo_max_rpm: float, mkt_current_rpm: float) -> pandas.DataFrame

.. py:function:: get_network_candidates(network_moves: pandas.DataFrame, lane_quick_ref: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_network_oppys(network_candidates: pandas.DataFrame, power_lane_annual_lh_loads: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_oppy_metrics(corridor_oppys: pandas.DataFrame, flex_oppys: pandas.DataFrame, network_oppys: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_origin_risk(high_vol_lanes: pandas.DataFrame, lane_quick_ref: pandas.DataFrame, carrier_churn_lanes: pandas.DataFrame, high_spend_vol_lanes: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_overall_spend_variability(load_actual_mkt_lh: pandas.DataFrame, window_start_date: datetime.datetime) -> float

.. py:function:: get_power_lane_annual_lh_loads(load_actual_mkt_lh: pandas.DataFrame, power_lane_name: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_power_lane_fleet_type(load_dat_lh: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_power_lane_name(lane_quick_ref: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_risk_metrics(high_vol_lanes: pandas.DataFrame, carrier_churn_lanes: pandas.DataFrame, high_spend_vol_lanes: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_rpm_trend_w_fcst(load_actual_mkt_lh: pandas.DataFrame, spot_weight: float, contract_weight: float, window_start_date: datetime.datetime, top_lanes: pandas.DataFrame, current_forecast: pandas.DataFrame, mkt_18mo_mean_rpm: float, mkt_18mo_max_rpm: float, mkt_current_rpm: float) -> pandas.DataFrame

.. py:function:: get_ship_rate_day_cutoff() -> int

.. py:function:: get_spend_variability_breakdown(lane_daily_loads: pandas.DataFrame, window_start_date: datetime.datetime, load_pga_revenue: pandas.DataFrame, overall_spend_variability: float, total_variability: float) -> pandas.DataFrame

.. py:function:: get_spot_weight(load_dat_lh: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_top_lanes(load_actual_mkt_lh: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_total_daily_revenue(lane_daily_loads: pandas.DataFrame, load_pga_revenue: pandas.DataFrame) -> pandas.DataFrame

.. py:function:: get_total_spend_trend_w_fcst(load_actual_mkt_lh: pandas.DataFrame, window_start_date: datetime.datetime, load_pga_revenue: pandas.DataFrame, top_lanes: pandas.DataFrame, lane_daily_loads: pandas.DataFrame, spot_weight: float, contract_weight: float, mkt_18mo_mean_rpm: float, mkt_18mo_max_rpm: float, mkt_current_rpm: float) -> pandas.DataFrame

.. py:function:: get_total_variability(total_daily_revenue: pandas.DataFrame, window_start_date: datetime.datetime) -> float

.. py:function:: get_trip_type_weighting(load_dat_trend: pandas.DataFrame, window_start_date: datetime.datetime) -> pandas.DataFrame

.. py:function:: get_window_start_date(load_dat_lh: pandas.DataFrame, day_cutoff: int) -> datetime.datetime