aequilibrae.utils.simwrapper.generate_simwrapper_config#

Utilities to generate SimWrapper dashboard configuration for an AequilibraE project.

Usage#

Generate SimWrapper dashboard for an open project#
>>> from aequilibrae.project import Project
>>> from aequilibrae.utils.simwrapper.generate_simwrapper_config import SimwrapperConfigGenerator
>>> prj = Project()
>>> prj.open('/path/to/project')
>>> gen = SimwrapperConfigGenerator(prj, output_dir='simwrapper')
>>> gen.write_yamls()

Notes

  • output_dir must be inside the project directory

Functions

main([argv])

Command-line entry point for generating SimWrapper configs.

Classes

SimwrapperConfigGenerator(project[, ...])

Generates SimWrapper dashboard configuration for an AequilibraE project.
class aequilibrae.utils.simwrapper.generate_simwrapper_config.SimwrapperConfigGenerator(project, output_dir='simwrapper', max_results_tables=3, results_tables=None, centroid_link_types=None)[source]#

Generates SimWrapper dashboard configuration for an AequilibraE project.

write_yamls()[source]#

Writes the SimWrapper dashboard YAML file.

aequilibrae.utils.simwrapper.generate_simwrapper_config.main(argv=None)[source]#

Command-line entry point for generating SimWrapper configs.

Example

aequilibrae-simwrapper –project /path/to/project –output-dir simwrapper