Skip to main content
Ctrl+K
The documentation pages are currently work-in-progress, if you have any suggestions for improvements please raise an issue on the caf.van repository.
Home Home

CAF.van 0.1.0+86.g270623c

  • Quick Start
  • User Guide
  • API Reference
    • Changelog
    • Issues
    • TfN GitHub
  • GitHub
  • Quick Start
  • User Guide
  • API Reference
  • Changelog
  • Issues
  • TfN GitHub
  • GitHub

Section Navigation

  • caf.van
    • caf.van.commute_segment
      • read_qs606
      • CommuteTripEnds
        • CommuteTripEnds.__init__
        • CommuteTripEnds.calc_trip_ends
        • CommuteTripEnds.estimate_attractions
        • CommuteTripEnds.estimate_productions
      • Rezone
        • Rezone.read
        • Rezone.rezone
        • Rezone.rezone_od
      • WarehouseParameters
    • caf.van.delivery_segment
      • zone_list
      • DeliveryParameters
      • DeliveryTripEnds
        • DeliveryTripEnds.__init__
        • DeliveryTripEnds.read
        • DeliveryTripEnds.read_parameters
    • caf.van.errors
      • BaseVanError
      • IncorrectParameterError
      • MissingColumnsError
      • MissingDataError
      • MissingInputsError
      • MissingLookupValuesError
      • MissingParameterError
      • MissingWorksheetError
      • NonNumericDataError
    • caf.van.lgv_inputs
      • filtered_employment
      • household_projections
      • lgv_parameters
      • load_warehouse_floorspace
      • read_study_area
      • read_time_factors
      • CommuteWarehousePaths
      • DwellingPaths
      • EmploymentPaths
      • GMInputs
      • InfillMethod
        • InfillMethod.method_lookup
        • InfillMethod.method
      • LGVInputPaths
      • PersonalArgs
      • Rezone
        • Rezone.read
        • Rezone.rezone
        • Rezone.rezone_od
      • ZoneTranslationDefinition
    • caf.van.lgv_model
      • annual_pa_to_od
      • balance_trip_ends
      • calculate_trip_ends
      • calculate_vehicle_kms
      • extract_cost_func_params
      • factor_1d
      • factor_totals
      • lgv_arg_parser
      • lgv_parameters
      • main
      • matrix_time_periods
      • produce_annual_matrices
      • produce_personal_matrix
      • read_time_factors
      • run_gravity_model
      • CommuteTripEnds
        • CommuteTripEnds.__init__
        • CommuteTripEnds.calc_trip_ends
        • CommuteTripEnds.estimate_attractions
        • CommuteTripEnds.estimate_productions
      • DataPaths
      • DeliveryTripEnds
        • DeliveryTripEnds.__init__
        • DeliveryTripEnds.read
        • DeliveryTripEnds.read_parameters
      • GMInputs
      • LGVInputPaths
      • LGVMatrices
        • LGVMatrices.__init__
        • LGVMatrices.asdict
      • LGVTripEnds
        • LGVTripEnds.__init__
        • LGVTripEnds.asdict
      • Rezone
        • Rezone.read
        • Rezone.rezone
        • Rezone.rezone_od
      • ServiceTripEnds
        • ServiceTripEnds.__init__
        • ServiceTripEnds.read
      • VanGravityModelResults
        • VanGravityModelResults.__init__
    • caf.van.matrix_validation
      • matrix_describe
      • MatrixReport
        • MatrixReport.__init__
        • MatrixReport.from_file
        • MatrixReport.write_to_excel
    • caf.van.rezone
      • read_csv
      • Parameters
        • Parameters.__init__
        • Parameters.check_params
        • Parameters.read
        • Parameters.write
      • Rezone
        • Rezone.read
        • Rezone.rezone
        • Rezone.rezone_od
      • IncorrectParameterError
      • MissingLookupValuesError
    • caf.van.service_segment
      • ServiceTripEnds
        • ServiceTripEnds.__init__
        • ServiceTripEnds.read
    • caf.van.utilities
      • check_file_path
      • check_folder
      • read_csv
      • read_excel
      • read_multi_sheets
      • to_dict
      • DataPaths
      • Parameters
        • Parameters.__init__
        • Parameters.check_params
        • Parameters.read
        • Parameters.write
      • MissingColumnsError
      • MissingParameterError
      • MissingWorksheetError

Indices

  • General Index
  • Python Module Index
  • API Reference
  • caf.van
  • caf.van.delivery_segment
  • DeliveryTripEnds
  • DeliveryTripEnds.read

DeliveryTripEnds.read#

DeliveryTripEnds.read()[source]#

Read the input data and perform any necessary conversions.

See also

read_parameters

Reads the parameters spreadsheet.

lgv_inputs.household_projections

Reads and converts household input CSV.

lgv_inputs.filtered_employment

Reads, filters and converts the BRES input CSV.

Return type:

None

previous

DeliveryTripEnds.__init__

next

DeliveryTripEnds.read_parameters

On this page
  • DeliveryTripEnds.read()
Edit on GitHub

© Copyright 2026, Transport for the North.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.20.0.