.rst .pdf

Contents

ensemble package

Subpackages

• ensemble.component package
  • Submodules
  • ensemble.component.dynamics module
    • Dynamics Model
  • ensemble.component.platoon_vehicle module
    • Platoon Vehicle
  • ensemble.component.platoonvehicleinfo module
  • ensemble.component.vehicle module
    • Vehicle Model
  • ensemble.component.vehiclelist module
    • Vehicle List
  • Module contents
• ensemble.control package
  • Subpackages
    • ensemble.control.operational package
      • Submodules
      • ensemble.control.operational.TestOperationalLayerEnsembleVissim module
      • ensemble.control.operational.basic_test module
      • ensemble.control.operational.operational module
      • ensemble.control.operational.operationalLayerTest module
      • ensemble.control.operational.operationalLayerTest_usage_example module
      • ensemble.control.operational.reference module
      • Module contents
    • ensemble.control.tactical package
      • Submodules
      • ensemble.control.tactical.gapcordinator module
      • ensemble.control.tactical.vehcoordinator module
      • Module contents
  • Submodules
  • ensemble.control.governor module
  • Module contents
• ensemble.handler package
  • Subpackages
    • ensemble.handler.symuvia package
      • Submodules
      • ensemble.handler.symuvia.configurator module
      • ensemble.handler.symuvia.connector module
      • ensemble.handler.symuvia.scenario module
      • ensemble.handler.symuvia.stream module
      • ensemble.handler.symuvia.xmlparser module
      • Module contents
    • ensemble.handler.vissim package
      • Submodules
      • ensemble.handler.vissim.configurator module
      • ensemble.handler.vissim.connector module
      • ensemble.handler.vissim.scenario module
      • ensemble.handler.vissim.stream module
      • Module contents
  • Module contents
• ensemble.input package
  • Submodules
  • ensemble.input.platoon_demand module
  • ensemble.input.scenario module
  • Module contents
• ensemble.logic package
  • Submodules
  • ensemble.logic.frozen_set module
    • Frozen Set
  • ensemble.logic.platoon_set module
    • Platoon Set
  • ensemble.logic.platoon_states module
  • ensemble.logic.publisher module
    • Publisher
  • ensemble.logic.runtime_machine module
    • Runtime Device
  • ensemble.logic.runtime_states module
    • Runtime States
  • ensemble.logic.statemachine module
  • ensemble.logic.subscriber module
    • Subscriber
  • Module contents
• ensemble.metaclass package
  • Submodules
  • ensemble.metaclass.connector module
    • Abstract Connector
  • ensemble.metaclass.controller module
    • Abstract Controller
  • ensemble.metaclass.coordinator module
    • Abstract Gap Coordinator
  • ensemble.metaclass.dynamics module
    • Abstract Dynamics
  • ensemble.metaclass.observer module
    • Abstract Observer
  • ensemble.metaclass.state module
    • States
  • ensemble.metaclass.stream module
    • Data Query
  • ensemble.metaclass.subject module
    • Abstract Subject
  • Module contents
• ensemble.tools package
  • Submodules
  • ensemble.tools.checkers module
    • Check module
  • ensemble.tools.connector_configurator module
  • ensemble.tools.constants module
    • Constants module
  • ensemble.tools.decorators module
    • Decorator utilities
  • ensemble.tools.exceptions module
  • ensemble.tools.geometry module
    • Auxiliary geometry
  • ensemble.tools.screen module
    • Module to log on screen
  • Module contents

Submodules

ensemble.cli module

ENSEMBLE Command Line Interface

Scenario launcher for ENSEMBLE simulations

ensemble.configurator module

Configurator

A class to store parameters for runtime execution

class ensemble.configurator.Configurator(**kwargs)

Bases: object

Configurator class for containing specific simulator parameter

Args:

verbose (bool):

Indicates if verbosity is required within the exit

info (bool):

Prints project information

platform (str):

Platform to run: Windows, Darwin, Linux

simulation_platform (str):

Traffic simulation platform: vissim, symuvia

scenario_files (list):

List of absolute files containing traffic scenarios

simulation_parameters (dict):

List of simulatio parameters. Check constants module for more information

create_platoon_registry()

Creates a platoon registry for all coordinators (FGC-RGC)

info: bool = True

initialize_operational_layer()

Initialize the Operational layer

library_path: str = ''

load_scenario()

load_socket()

Determines simulation platform to connect

platform: str = 'Linux'

push_data()

Pushes data updated back to the simulator

query_data()

Queries data from the simulator and updates vehicle list

set_simulation_platform(simulation_platform: str = '') → None

A simpler setter for the simulation platform based on OS

Parameters

simulation_platform (str) – “symuvia” or “vissim”, defaults to “”

sim_steps: int = 0

simulation_platform: str = ''

property total_steps

update_platoon_registry()

Updates the platoon vehicle registry and the tactical layer

update_traffic_state()

Update the vehicle list and the platoon corresponding vehicle state

update_values(**kwargs) → None

Configurator updater, pass a with keyword arguments to update. Just pass the desired parameter as a kewyword argument.

property vehicle_registry

verbose: bool = False

ensemble.ensemble module

ENSEMBLE Command Line Commands

Command definitions

ensemble.ensemble.check_consistency(configurator: ensemble.configurator.Configurator) → bool

Checks consistency of the current configurator

Parameters

file (configurator {Configurator} -- Configurator) –

Returns

bool – True in case all is correct

ensemble.ensemble.launch_simulation(configurator: ensemble.configurator.Configurator)

Launches a RuntimeDevice starting from a configurator

Parameters

file (configurator {Configurator} -- Configurator) –

Example

Use the the function from a python package as::

>>> from ensemble import launch_simulation, Configurator
>>> c = Configurator() # default arguments
>>> library = 'path/to/simulator'
>>> scenarios = ('path/to/scenario',)
>>> config.update_values(library_path=library, scenario_files=scenario)
>>> launch_simulation(configurator)

ensemble.ensemble.run_operational_runtime()

Considers a demonstration scenario to run in the operational layer with components from the framework. The purpose is to test components from the tactical layer

Module contents

ensemble ensemble.component package