PLANit(+)

Top-level PLANit instance

Description

This class is the starting point for all PLANit traffic assignment runs. It either reads in inputs from a specific location or from the current working directory upon creation of the object. Further configuration for the run is left to the user.

Defaults

Name	Value	Type	Unit
`PROJECT_PATH`	`.`, i.e., current working directory	`string`	`None`
Output Formatter	Object instance	Default Output Formatter (`OutputFormatter.PLANit_IO`)	N/A

Parameters

.PLANit(project_path)

with

Parameter	Type	Unit	Compulsory	Default	Description
project_path	`string`	`None`	NO	`PROJECT_PATH`	Location of directory to find input files

Methods

PLANit exposes the following methods

Name	Description
`.set(+)`	Set the type of traffic assignment method to use
`.activate(+)`	Activate additional types of output that are to be generated
`.deactivate(+)`	Deactivate previously activated types of output
`.run()`	Run simulation

Properties

Planit exposes the follogin properties

Property	Availability	Description
`.assignment`	Post calling .set(+)	Access to assignment instance
`.demands`	Always	Access to in memory version of the demand inputs
`.initial_costs`	Always	Access to initial cost configuration
`.memory`	Post calling `.activate(OutputFormatter.MEMORY)`	Access to in-memory configuration of results including results themselves (Post calling .run())
`.network`	Always	Access to in-memory version of the physical network infrastructure
`.output`	Always	Access to configuration for native output format (activated by default)
`.zoning`	Always	Access to in-memory version of the zoning structure

Example 1

from planit import *

# create a PLANit instance using "." as the location for the input files
planit_instance = PLANit()

Example 2

from planit import *

# create a PLANit instance using a custom location to search for input files instead
planit_instance = PLANit("c:/users/<username>/my_project")