leaf_engine.adapt.exports

Submodules

• leaf_engine.adapt.exports.consolidated_flex_excel
• leaf_engine.adapt.exports.consolidated_network_excel
• leaf_engine.adapt.exports.corridor
• leaf_engine.adapt.exports.domicile_ranking
• leaf_engine.adapt.exports.explorer
• leaf_engine.adapt.exports.lane_plan
• leaf_engine.adapt.exports.legacy_csv
• leaf_engine.adapt.exports.network_actions
• leaf_engine.adapt.exports.network_raw
• leaf_engine.adapt.exports.observations
• leaf_engine.adapt.exports.ops_plan_template
• leaf_engine.adapt.exports.postprocessing
• leaf_engine.adapt.exports.quick_ref

Functions

export_consolidated_flex_excel(action_cxt, etl_cxt, ...)
export_consolidated_network_excel(action_cxt, ...)
export_domicile_ranking_csv(adapt_cxt, path)
export_explorer_csv(explorer_cxt, etl_cxt, ...)
export_lane_level_corridor_csv(adapt_cxt, path)
export_lane_level_lane_plans_csv(adapt_cxt, path)	Exports shipment-level lane plans to CSV.
export_lane_level_ops_plan_template(adapt_cxt, ...)	This function generates, formats, and exports the data that serves as the
export_legacy_csvs(etl_cxt, adapt_cxt, net_cxt, ...)
export_lighthouse_ptp_mapping_lanes(→ None)
export_ops_plan_template(etl_cxt, adapt_cxt, oa_cxt, ...)	This function generates, formats, and exports the data that serves as the
export_postprocessing(data_cxt, postprocessing_cxt, path)	Writes postprocessing outputs.
export_ptp_mapping_lanes(→ None)
export_quick_ref_csv(explorer_cxt, etl_cxt, path, ...)
export_quick_ref_lanes_csv(adapt_cxt, path, ...)
export_shipment_level_corridor_csv(explorer_cxt, ...)
export_shipment_level_lane_plans_csv(etl_cxt, path)	Exports shipment-level lane plans to CSV.

Package Contents

leaf_engine.adapt.exports.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)

Parameters:

• 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) –

leaf_engine.adapt.exports.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)

Parameters:

• action_cxt (leaf_engine.adapt.context.AdaptConsolidatedNetworkActionContext) –

• adapt_cxt (leaf_engine.adapt.context.AdaptDataContext) –

• equipment_class (str) –

• path (str) –

• env (str) –

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

Parameters:

• adapt_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptDataContext) –

• path (str) –

leaf_engine.adapt.exports.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)

Parameters:

• 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) –

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

Parameters:

• adapt_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptDataContext) –

• path (str) –

leaf_engine.adapt.exports.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:

• etl_cxt – ETL context object.

• path (str) – Path to export CSV to.

• adapt_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptDataContext) –

leaf_engine.adapt.exports.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.

Parameters:

• adapt_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptDataContext) – adapt data context

• action_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptActionContext) – adapt actions context

• rate_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptSyntheticRateContext) – synthetic rates context

• equipment_class (str) – equipment class for which the ops plan has to be exported

• env (str) – environment for export

• path (str) – path to where the ops plan has to be exported

leaf_engine.adapt.exports.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)

Parameters:

• 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) –

leaf_engine.adapt.exports.export_lighthouse_ptp_mapping_lanes(adapt_cxt: leaf_engine.adapt.context.AdaptDataContext, path: str, input_csv_path: str) → None

Parameters:

• adapt_cxt (leaf_engine.adapt.context.AdaptDataContext) –

• path (str) –

• input_csv_path (str) –

Return type:

None

leaf_engine.adapt.exports.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.

Parameters:

• etl_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptETLContext) – etl context

• adapt_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptDataContext) – adapt data context

• oa_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptOAContext) – opportunity assessment context

• action_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptActionContext) – adapt actions context

• rate_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptSyntheticRateContext) – synthetic rates context

• explorer_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptExplorerContext) – explorer context

• env (str) – environment for export

• path (str) – path to where the ops plan has to be exported

leaf_engine.adapt.exports.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.

Parameters:

• data_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptDataContext) –

• postprocessing_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptPostprocessingContext) –

• path (str) –

leaf_engine.adapt.exports.export_ptp_mapping_lanes(adapt_cxt: leaf_engine.adapt.context.AdaptDataContext, path: str, input_csv_path: str) → None

Parameters:

• adapt_cxt (leaf_engine.adapt.context.AdaptDataContext) –

• path (str) –

• input_csv_path (str) –

Return type:

None

leaf_engine.adapt.exports.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)

Parameters:

• explorer_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptExplorerContext) –

• etl_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptETLContext) –

• path (str) –

• zero_out_linehaul (bool) –

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

Parameters:

• adapt_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptDataContext) –

• path (str) –

• input_csv_path (str) –

• zero_out_linehaul (bool) –

leaf_engine.adapt.exports.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)

Parameters:

• explorer_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptExplorerContext) –

• etl_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptETLContext) –

• path (str) –

leaf_engine.adapt.exports.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:

• etl_cxt (leaf_engine.adapt.context.adapt_contexts.AdaptETLContext) – ETL context object.

• path (str) – Path to export CSV to.