PLANit-Python Reference

Reference manual

Each PLANit-Python run starts with instantiating a PLANit object instance = Planit().

Whenever you see a ‘+’ in brackets for a method or class entry in this manual, it indicates it accepts one or more parameters. For example there is a method Planit().create_project(+). this indicates the create_project method takes one or more parameters to configure the method call.

Currently, only a single instance of a Planit() object can be present in your environment as this singular entity maintains the connection ot the underlying Java JVM. This limitation may be addressed in future releases of PLANit

See also

Planit()


Planit()

Top-level PLANit instance

PlanitProject

Planit assignment project instance

Assignment

Assignment implementations

Converter Factory

Converter Factory instance

Converter Reader

Converter Readers

Converter Writer

Converter Writers

Demands

Demands implementation

Enums

Enum based configuration classes

Gap Function

Gap Function implementations

Initial Cost

Initial Cost implementation

Output Configuration

Output (type) configuration implementations

Output Formatters

Output formatter implementations

Physical Cost

Physical Cost implementations

Physical Network

Physical Network implementation

Smoothing

Smoothing implementations

Stop Criterion

Stop Criterion implementations

Virtual Cost

Virtual Cost implementations

Zoning

Zoning implementation