PlanitProject

Planit assignment project instance

Description

This class is the starting point for all 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
Output Formatter	Object instance	Default Output Formatter (`OutputFormatter.PLANIT_IO`)	N/A

Methods

PlanitProject 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

PlanitProject exposes the following 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()
planit_project = planit_instance.create_project("c:/users/<username>/my_project")