QueryArgs#

class caf.ntem.inputs.QueryArgs(*, output_path, db_path, planning_runs=None, trip_end_by_direction_runs=None, car_ownership_runs=None, trip_end_by_car_availability_runs=None)[source]#

Bases: InputBase

Queries config that defines the specification of the outputted data.

Attributes

`logging_path`	Return the logging path for the module.
`model_config`	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
`output_path`	Path to directory to output the processed NTEM data.
`db_path`	Path to NTEM database, which has ben outputted by the build module.
`planning_runs`	Define the planning queries.
`trip_end_by_direction_runs`	Define the trip end by direction queries.
`car_ownership_runs`	Define the car ownership queries.
`trip_end_by_car_availability_runs`	Define the trip end by car availability queries.

Methods

run()

Run the query process.

Attributes Documentation

Parameters:

output_path (Path)
db_path (Annotated[Path, PathType(path_type=file)])
planning_runs (list[PlanningParams] | None)
trip_end_by_direction_runs (list[TripEndByDirectionRunParams] | None)
car_ownership_runs (list[CarOwnershipParams] | None)
trip_end_by_car_availability_runs (list[TripEndByCarAvailabilityRunParams] | None)

logging_path#: Return the logging path for the module.

model_config = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

output_path: pathlib.Path[source]#: Path to directory to output the processed NTEM data.

db_path: pydantic.FilePath[source]#: Path to NTEM database, which has ben outputted by the build module.

planning_runs: list[PlanningParams] | None[source]#: Define the planning queries.

trip_end_by_direction_runs: list[TripEndByDirectionRunParams] | None[source]#: Define the trip end by direction queries.

car_ownership_runs: list[CarOwnershipParams] | None[source]#: Define the car ownership queries.

trip_end_by_car_availability_runs: list[TripEndByCarAvailabilityRunParams] | None[source]#: Define the trip end by car availability queries.