Contents

symupy.plugins.reader package

Submodules

symupy.plugins.reader.loader module

symupy.plugins.reader.loader.add_dir_to_plugin(folder)[source]

Add dir folder to READER_PLUGIN_DIRS.

Parameters

folder (str) – Path to dir to add.

symupy.plugins.reader.loader.get_all_readers()[source]

Parse all python file in READER_PLUGIN_DIRS to get plugin classes.

Returns

Return dict with input and output reader classes.

Return type

dict

symupy.plugins.reader.loader.get_class(file)[source]

From a file return a dict or input and output readers.

Parameters

file (str) – Plugin file to parse.

Returns

List of input reader and list of output reader.

Return type

(list, list)

symupy.plugins.reader.loader.load_plugins(type)[source]

Load all plugins contained in READER_PLUGIN_DIRS.

Parameters

type (str) – Type of reader to load (‘input’ or ‘output’).

Returns

Dict with plugin classes.

Return type

dict

symupy.plugins.reader.symuflow module

class symupy.plugins.reader.symuflow.SymuFlowNetworkReader(file, remove_comments=True)[source]

Bases: symupy.abstractions.reader.AbstractNetworkReader

Short summary.

Parameters

  • file (type) – Description of parameter file.

  • remove_comments (type) – Description of parameter remove_comments.

_file

Description of attribute _file.

Type

type

_parser

Description of attribute _parser.

Type

type

_prefix

Description of attribute _prefix.

Type

type

_id

Description of attribute _id.

Type

type

_ext

Description of attribute _ext.

Type

type

get_network()[source]
info_public_transport()[source]
info_sensors()[source]
info_termination_zones()[source]
iter_public_transport(id)[source]
iter_sensor(id)[source]
iter_termination_zones(id)[source]
nb_troncons()[source]
class symupy.plugins.reader.symuflow.SymuFlowTrafficDataReader(traficdatafile, lru_cache_size=None)[source]

Bases: symupy.abstractions.reader.AbstractTrafficDataReader

Reader for output of SymuFlow simulation.

Parameters

  • traficdatafile (str) – Path to the SymuFlow output xml file.

  • lru_cache_size (int) – Description of parameter lru_cache_size.

_file

Description of attribute _file.

Type

type

parser

Description of attribute parser.

Type

type

_inst

Description of attribute _inst.

Type

type

_vehs

Description of attribute _vehs.

Type

type

_get_ids_from_inst[source]

Description of attribute _get_ids_from_inst.

Type

type

_ext

Description of attribute _ext.

Type

type

clear_cache()[source]
count_OD(period=None)[source]
get_OD(origin, destination, start_period=None, end_period=None)[source]
get_path(vehid)[source]
get_trip(vehid)[source]

symupy.plugins.reader.symumaster module

class symupy.plugins.reader.symumaster.SymuMasterDistributionReader(distribution)[source]

Bases: symupy.abstractions.reader.AbstractTrafficDataReader

get_OD(origin, destination, period=None, outer_loop=None, inner_loop=None)[source]
class symupy.plugins.reader.symumaster.SymuMasterFinalPPathsReader(final_ppaths)[source]

Bases: symupy.abstractions.reader.AbstractTrafficDataReader

get_path(userid)[source]
get_trip(userid)[source]
class symupy.plugins.reader.symumaster.SymuMasterPPathsReader(ppaths, final_ppaths, distribution)[source]

Bases: symupy.abstractions.reader.AbstractTrafficDataReader

get_OD(origin, destination, period=None, outer_loop=None, inner_loop=None)[source]

Module contents

symupy.plugins package symupy.postprocess package