6.3.14. run_base

run_base()[source]

Defines the vehicle-processing model.

Processes a vehicle from the file path to the write of its outputs.

digraph dmap { node [style=filled] label = <dmap> splines = ortho style = filled 0 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/CO2MPAS_model.html">CO2MPAS model</TD></TR></TABLE>> fillcolor=yellow shape=note style=filled tooltip="Calibrates the models with WLTP data and predicts NEDC cycle."] 1 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">data</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=data] 2 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/default_output_file_name.html">default_output_file_name</TD></TR></TABLE>> fillcolor=springgreen shape=box tooltip="Returns the output file name."] 3 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/default_start_time.html">default_start_time</TD></TR></TABLE>> fillcolor=springgreen shape=box tooltip="Returns the default run start time."] 4 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/default_timestamp.html">default_timestamp</TD></TR></TABLE>> fillcolor=springgreen shape=box tooltip="Returns the default timestamp."] 5 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/default_vehicle_name.html">default_vehicle_name</TD></TR></TABLE>> fillcolor=springgreen shape=box tooltip="Returns the vehicle name."] 6 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">dsp_solution</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip="Co2mpas model after dispatching."] 7 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">encrypt_inputs</TD></TR><TR><TD align="RIGHT" border="1">default</TD><TD align="LEFT" border="1">True</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=encrypt_inputs] 8 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">encryption_keys</TD></TR><TR><TD align="RIGHT" border="1">default</TD><TD align="LEFT" border="1">./dice.co2mpas.keys</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=encryption_keys] 9 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">engineering_mode</TD></TR><TR><TD align="RIGHT" border="1">default</TD><TD align="LEFT" border="1">False</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=engineering_mode] 10 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">flag</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=flag] 11 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/get_template_file_name.html">get_template_file_name</TD></TR></TABLE>> fillcolor=springgreen shape=box tooltip="Returns the template file name."] 12 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">input_file_name</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip="File path."] 13 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/make_report.html">make_report</TD></TR></TABLE>> fillcolor=yellowgreen shape=note style=filled tooltip="Produces a vehicle report from CO2MPAS outputs."] 14 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">meta</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=meta] 15 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">only_summary</TD></TR><TR><TD align="RIGHT" border="1">default</TD><TD align="LEFT" border="1">False</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=only_summary] 16 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">output_data</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=":return:"] 17 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">output_file_name</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip="File name where to plot the workflow."] 18 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">output_folder</TD></TR><TR><TD align="RIGHT" border="1">default</TD><TD align="LEFT" border="1">.</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip="Output folder."] 19 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">output_ta_file</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=output_ta_file] 20 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">output_template</TD></TR><TR><TD align="RIGHT" border="1">default</TD><TD align="LEFT" border="1">/home/docs/checkouts/readthedocs.org/user_builds/co2mpas-ta/checkouts/latest/pCO2SIM/src/co2mpas/co2mpas_output_template.xlsx</TD></TR><TR><TD align="RIGHT" border="1">initial_dist</TD><TD align="LEFT" border="1">10</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip="Template output."] 21 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/parse_dsp_solution.html">parse_dsp_solution</TD></TR></TABLE>> fillcolor=springgreen shape=box tooltip="Parses the co2mpas model results."] 22 [label=plot fillcolor=gold shape=egg] 23 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/plot_model_workflow.html">plot_model_workflow</TD></TR><TR><TD align="RIGHT" border="1">input_domain</TD><TD align="LEFT" border="1" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/check_first_arg.html">check_first_arg</TD></TR><TR><TD align="RIGHT" border="1">weight</TD><TD align="LEFT" border="1">30</TD></TR></TABLE>> fillcolor=springgreen shape=box tooltip="Defines the kwargs to plot the dsp workflow."] 24 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">plot_workflow</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=plot_workflow] 25 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">report</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=report] 26 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">run_base</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=run_base] 27 [label=sink fillcolor=black fontcolor=white shape=egg] 28 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">soft_validation</TD></TR><TR><TD align="RIGHT" border="1">default</TD><TD align="LEFT" border="1">False</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=soft_validation] 29 [label=start fillcolor=red shape=egg] 30 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">start_time</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip="Run start time."] 31 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">summary</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=summary] 32 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">template_file_name</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip="Template file name."] 33 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">timestamp</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip="Run timestamp."] 34 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">type_approval_mode</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=type_approval_mode] 35 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">use_selector</TD></TR><TR><TD align="RIGHT" border="1">default</TD><TD align="LEFT" border="1">False</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=use_selector] 36 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/validate_base.html">validate_base</TD></TR><TR><TD align="RIGHT" border="1">input_domain</TD><TD align="LEFT" border="1" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/check_first_arg-0.html">check_first_arg</TD></TR><TR><TD align="RIGHT" border="1">weight</TD><TD align="LEFT" border="1">10</TD></TR></TABLE>> fillcolor=springgreen shape=box tooltip=validate_base] 37 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/validate_meta.html">validate_meta</TD></TR></TABLE>> fillcolor=springgreen shape=box tooltip=validate_meta] 38 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">validated_base</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=validated_base] 39 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">validated_meta</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=validated_meta] 40 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">vehicle_family_id</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip=vehicle_family_id] 41 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2">vehicle_name</TD></TR></TABLE>> fillcolor=cyan shape=box style="rounded,filled" tooltip="File name."] 42 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/write_outputs.html">write_outputs</TD></TR><TR><TD align="RIGHT" border="1">input_domain</TD><TD align="LEFT" border="1" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/lambda.html">&lt;lambda&gt;</TD></TR></TABLE>> fillcolor=yellowgreen shape=note style=filled tooltip="Writes on files the outputs of the CO2MPAS model."] 43 [label=<<TABLE border="0" cellspacing="0"><TR><TD border="0" colspan="2" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/write_ta_output.html">write_ta_output</TD></TR><TR><TD align="RIGHT" border="1">input_domain</TD><TD align="LEFT" border="1" href="./dispatcher-68cc624eadc0ec2ef6a430a10ca98e61e904ea09/check_first_arg-1.html">check_first_arg</TD></TR></TABLE>> fillcolor=yellowgreen shape=note style=filled tooltip=write_ta_output] 7 -> 43 32 -> 42 24 -> 23 25 -> 42 8 -> 43 17 -> 42 5 -> 41 9 -> 36 41 -> 23 33 -> 2 12 -> 5 30 -> 4 13 -> 31 0 -> 6 37 -> 39 17 -> 23 1 -> 36 40 -> 43 39 -> 0 12 -> 11 41 -> 2 34 -> 43 36 -> 38 14 -> 37 23 -> 22 33 -> 43 10 -> 42 41 -> 13 35 -> 36 30 -> 43 4 -> 33 6 -> 21 30 -> 42 13 -> 25 38 -> 0 20 -> 11 28 -> 37 14 -> 43 2 -> 17 26 -> 36 1 -> 43 18 -> 2 43 -> 19 15 -> 42 21 -> 16 28 -> 36 18 -> 43 16 -> 13 25 -> 43 42 -> 27 29 -> 3 11 -> 32 3 -> 30 }

run_base’s data
data  
dsp_solution Co2mpas model after dispatching.
encrypt_inputs  
encryption_keys  
engineering_mode  
flag  
input_file_name File path.
meta  
only_summary  
output_data
return:
output_file_name File name where to plot the workflow.
output_folder Output folder.
output_ta_file  
output_template Template output.
plot It constructs a unique constant that behaves like a string.
plot_workflow  
report  
run_base  
sink Sink node of the dispatcher that collects all unused outputs.
soft_validation  
start Starting node that identifies initial inputs of the workflow.
start_time Run start time.
summary  
template_file_name Template file name.
timestamp Run timestamp.
type_approval_mode  
use_selector  
validated_base  
validated_meta  
vehicle_family_id  
vehicle_name File name.
run_base’s functions
default_output_file_name Returns the output file name.
default_start_time Returns the default run start time.
default_timestamp Returns the default timestamp.
default_vehicle_name Returns the vehicle name.
get_template_file_name Returns the template file name.
parse_dsp_solution Parses the co2mpas model results.
plot_model_workflow Defines the kwargs to plot the dsp workflow.
validate_base  
validate_meta  
run_base’s dispatchers
CO2MPAS model Calibrates the models with WLTP data and predicts NEDC cycle.
make_report Produces a vehicle report from CO2MPAS outputs.
write_outputs Writes on files the outputs of the CO2MPAS model.
write_ta_output write_ta_output
Returns:The vehicle-processing model.
Return type:Dispatcher