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">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]
	8 [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]
	9 [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."]
	10 [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."]
	11 [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."]
	12 [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]
	13 [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:"]
	14 [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."]
	15 [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."]
	16 [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/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."]
	17 [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."]
	18 [label=plot fillcolor=gold shape=egg]
	19 [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."]
	20 [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]
	21 [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]
	22 [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]
	23 [label=sink fillcolor=black fontcolor=white shape=egg]
	24 [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]
	25 [label=start fillcolor=red shape=egg]
	26 [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."]
	27 [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]
	28 [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."]
	29 [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."]
	30 [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]
	31 [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]
	32 [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]
	33 [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."]
	34 [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."]
	14 -> 19
	21 -> 34
	11 -> 27
	1 -> 31
	15 -> 2
	12 -> 34
	26 -> 34
	14 -> 34
	25 -> 3
	30 -> 31
	28 -> 34
	33 -> 11
	24 -> 31
	10 -> 5
	16 -> 9
	33 -> 2
	13 -> 11
	29 -> 2
	3 -> 26
	6 -> 17
	17 -> 13
	5 -> 33
	20 -> 19
	22 -> 31
	19 -> 18
	10 -> 9
	4 -> 29
	0 -> 6
	34 -> 23
	33 -> 19
	31 -> 32
	32 -> 0
	26 -> 4
	2 -> 14
	7 -> 31
	9 -> 28
	8 -> 34
	11 -> 21
}
run_base’s data
data  
dsp_solution Co2mpas model after dispatching.
engineering_mode  
flag  
input_file_name File path.
only_summary  
output_data
return:
output_file_name File name where to plot the workflow.
output_folder Output folder.
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.
use_selector  
validated_base  
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  
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.
Returns:The vehicle-processing model.
Return type:Dispatcher