leaf_engine.adapt.exports.lane_plan
===================================

.. py:module:: leaf_engine.adapt.exports.lane_plan


Attributes
----------

.. autoapisummary::

   leaf_engine.adapt.exports.lane_plan.planning_caller


Functions
---------

.. autoapisummary::

   leaf_engine.adapt.exports.lane_plan.create_lane_plan
   leaf_engine.adapt.exports.lane_plan.export_lane_level_lane_plans_csv
   leaf_engine.adapt.exports.lane_plan.export_lane_plans_csv
   leaf_engine.adapt.exports.lane_plan.export_shipment_level_lane_plans_csv


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

.. py:function:: 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.

   :param company_id: Company ID.
   :param power_lane_id: Power lane ID.
   :param route_id: Routing Route ID.
   :param mean_weekly_lane_loads: Mean weekly lane loads.
   :param o_zip: Origin zip.
   :param d_zip: Destination zip.
   :param equipment_class: Equipment class.
   :param fsc_id: Fuel surcharge schedule ID.


.. py:function:: export_lane_level_lane_plans_csv(adapt_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptDataContext, path: str)

   Exports shipment-level lane plans to CSV.

   :param etl_cxt: ETL context object.
   :param path: Path to export CSV to.


.. py:function:: 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.

   :param lane_plans: List of lane plans.
   :param company_name: Name of company.
   :param equipment_class: Equipment class.
   :param batch_date: Batch date.
   :param path: Path of folder to export file to.


.. py:function:: export_shipment_level_lane_plans_csv(etl_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptETLContext, path: str)

   Exports shipment-level lane plans to CSV.

   :param etl_cxt: ETL context object.
   :param path: Path to export CSV to.


.. py:data:: planning_caller