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

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


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/leaf_engine/adapt/exports/consolidated_flex_excel/index
   /autoapi/leaf_engine/adapt/exports/consolidated_network_excel/index
   /autoapi/leaf_engine/adapt/exports/corridor/index
   /autoapi/leaf_engine/adapt/exports/domicile_ranking/index
   /autoapi/leaf_engine/adapt/exports/explorer/index
   /autoapi/leaf_engine/adapt/exports/lane_plan/index
   /autoapi/leaf_engine/adapt/exports/legacy_csv/index
   /autoapi/leaf_engine/adapt/exports/network_actions/index
   /autoapi/leaf_engine/adapt/exports/network_raw/index
   /autoapi/leaf_engine/adapt/exports/observations/index
   /autoapi/leaf_engine/adapt/exports/ops_plan_template/index
   /autoapi/leaf_engine/adapt/exports/postprocessing/index
   /autoapi/leaf_engine/adapt/exports/quick_ref/index


Functions
---------

.. autoapisummary::

   leaf_engine.adapt.exports.export_consolidated_flex_excel
   leaf_engine.adapt.exports.export_consolidated_network_excel
   leaf_engine.adapt.exports.export_domicile_ranking_csv
   leaf_engine.adapt.exports.export_explorer_csv
   leaf_engine.adapt.exports.export_lane_level_corridor_csv
   leaf_engine.adapt.exports.export_lane_level_lane_plans_csv
   leaf_engine.adapt.exports.export_lane_level_ops_plan_template
   leaf_engine.adapt.exports.export_legacy_csvs
   leaf_engine.adapt.exports.export_lighthouse_ptp_mapping_lanes
   leaf_engine.adapt.exports.export_ops_plan_template
   leaf_engine.adapt.exports.export_postprocessing
   leaf_engine.adapt.exports.export_ptp_mapping_lanes
   leaf_engine.adapt.exports.export_quick_ref_csv
   leaf_engine.adapt.exports.export_quick_ref_lanes_csv
   leaf_engine.adapt.exports.export_shipment_level_corridor_csv
   leaf_engine.adapt.exports.export_shipment_level_lane_plans_csv


Package Contents
----------------

.. py:function:: export_consolidated_flex_excel(action_cxt: leaf_engine.adapt.context.AdaptActionContext, etl_cxt: leaf_engine.adapt.context.AdaptETLContext, adapt_cxt: leaf_engine.adapt.context.AdaptDataContext, path: str, env: str)

.. py:function:: export_consolidated_network_excel(action_cxt: leaf_engine.adapt.context.AdaptConsolidatedNetworkActionContext, adapt_cxt: leaf_engine.adapt.context.AdaptDataContext, equipment_class: str, path: str, env: str)

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

.. py:function:: export_explorer_csv(explorer_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptExplorerContext, etl_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptETLContext, postprocessing_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptPostprocessingContext, path: str, env: str)

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

.. 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_level_ops_plan_template(adapt_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptDataContext, action_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptActionContext, rate_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptSyntheticRateContext, equipment_class: str, env: str, path: str)

   This function generates, formats, and exports the data that serves as the
   initial Ops Plans for a particular shipper. An Ops Plan is Leaf's way of
   recording how we expect to manage a Shipper's freight in a standardized way
   so that they can be accessed by our teams. The Ops Plan includes
   information about the volume on the lane, ways that we plan to contract the
   lane with LSPs, the expected pricing for those contracts, and the expected
   time Leaf needs to put in place those contracts.

   NB: Ops Plans are created/stored for any unique combination of Shipper,
   Lane, and Equipment Type, and are owned by CX Demand.


   :param adapt_cxt: adapt data context
   :param action_cxt: adapt actions context
   :param rate_cxt: synthetic rates context
   :param equipment_class: equipment class for which the ops plan has to be exported
   :param env: environment for export
   :param path: path to where the ops plan has to be exported


.. py:function:: export_legacy_csvs(etl_cxt: leaf_engine.adapt.context.AdaptETLContext, adapt_cxt: leaf_engine.adapt.context.AdaptDataContext, net_cxt: leaf_engine.adapt.context.AdaptNetworkContext, obs_cxt: leaf_engine.adapt.context.AdaptObservationContext, action_cxt: leaf_engine.adapt.context.AdaptActionContext, path: str)

.. py:function:: export_lighthouse_ptp_mapping_lanes(adapt_cxt: leaf_engine.adapt.context.AdaptDataContext, path: str, input_csv_path: str) -> None

.. py:function:: export_ops_plan_template(etl_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptETLContext, adapt_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptDataContext, oa_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptOAContext, action_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptActionContext, rate_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptSyntheticRateContext, explorer_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptExplorerContext, env: str, path: str)

   This function generates, formats, and exports the data that serves as the
   initial Ops Plans for a particular shipper. An Ops Plan is Leaf's way of
   recording how we expect to manage a Shipper's freight in a standardized way
   so that they can be accessed by our teams. The Ops Plan includes
   information about the volume on the lane, ways that we plan to contract the
   lane with LSPs, the expected pricing for those contracts, and the expected
   time Leaf needs to put in place those contracts.

   NB: Ops Plans are created/stored for any unique combination of Shipper,
   Lane, and Equipment Type, and are owned by CX Demand.


   :param etl_cxt: etl context
   :param adapt_cxt: adapt data context
   :param oa_cxt: opportunity assessment context
   :param action_cxt: adapt actions context
   :param rate_cxt: synthetic rates context
   :param explorer_cxt: explorer context
   :param env: environment for export
   :param path: path to where the ops plan has to be exported


.. py:function:: export_postprocessing(data_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptDataContext, postprocessing_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptPostprocessingContext, path: str)

   Writes postprocessing outputs.


.. py:function:: export_ptp_mapping_lanes(adapt_cxt: leaf_engine.adapt.context.AdaptDataContext, path: str, input_csv_path: str) -> None

.. py:function:: export_quick_ref_csv(explorer_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptExplorerContext, etl_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptETLContext, path: str, zero_out_linehaul: bool)

.. py:function:: export_quick_ref_lanes_csv(adapt_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptDataContext, path: str, input_csv_path: str, zero_out_linehaul: bool)

.. py:function:: export_shipment_level_corridor_csv(explorer_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptExplorerContext, etl_cxt: leaf_engine.adapt.context.adapt_contexts.AdaptETLContext, path: str)

.. 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.