leaf_engine.adapt.exports.lane_plan

Attributes

planning_caller

Functions

create_lane_plan(→ dict)

Creates a lane plan for a given power lane.

export_lane_level_lane_plans_csv(adapt_cxt, path)

Exports shipment-level lane plans to CSV.

export_lane_plans_csv(lane_plans, company_name, ...)

Exports lane plans to CSV.

export_shipment_level_lane_plans_csv(etl_cxt, path)

Exports shipment-level lane plans to CSV.

Module Contents

leaf_engine.adapt.exports.lane_plan.create_lane_plan(company_id: int, power_lane_id: str, route_id: str, mean_weekly_lane_loads: int, o_zip: str, d_zip: str, equipment_class: str, fsc_id: str | None = None) → dict

Creates a lane plan for a given power lane.

Calls the planning service.

Wrap with joblib for parallelization.

Parameters:

  • company_id (int) – Company ID.

  • power_lane_id (str) – Power lane ID.

  • route_id (str) – Routing Route ID.

  • mean_weekly_lane_loads (int) – Mean weekly lane loads.

  • o_zip (str) – Origin zip.

  • d_zip (str) – Destination zip.

  • equipment_class (str) – Equipment class.

  • fsc_id (str | None) – Fuel surcharge schedule ID.

Return type:

dict

leaf_engine.adapt.exports.lane_plan.export_lane_level_lane_plans_csv(adapt_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptDataContext, path: str)

Exports shipment-level lane plans to CSV.

Parameters:
leaf_engine.adapt.exports.lane_plan.export_lane_plans_csv(lane_plans: list[dict], company_name: str, equipment_class: str, batch_date: str, path: str)

Exports lane plans to CSV.

Performs some transforms and cleanup before exporting.

Parameters:

  • lane_plans (list[dict]) – List of lane plans.

  • company_name (str) – Name of company.

  • equipment_class (str) – Equipment class.

  • batch_date (str) – Batch date.

  • path (str) – Path of folder to export file to.

leaf_engine.adapt.exports.lane_plan.export_shipment_level_lane_plans_csv(etl_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptETLContext, path: str)

Exports shipment-level lane plans to CSV.

Parameters:
leaf_engine.adapt.exports.lane_plan.planning_caller