Skip to main content
`Ctrl`+`K`

# aequilibrae.project.Project

class aequilibrae.project.Project

  AequilibraE project class

  Create Project

      >>> new_project = Project()
      >>> new_project.new(project_path)

  Open Project

      >>> existing_project = Project()
      >>> existing_project.open(project_path)

  __init__()

  Methods

  `__init__`() |
  `activate`() |
  `check_file_indices`() | Makes results_database.sqlite and the matrices folder compatible with project database
  `close`() | Safely closes the project
  `connect`() |
  `deactivate`() |
  `from_path`(project_folder) |
  `log`() | Returns a log object
  `new`(project_path) | Creates a new project
  `open`(project_path) | Loads project from disk

  Attributes

  `parameters` |
  `project_parameters` |
  `zoning` |

  activate()
  check_file_indices() → None

    Makes results_database.sqlite and the matrices folder compatible with project database

  close() → None

    Safely closes the project

  connect()
  deactivate()
  classmethod from_path(project_folder)
  log() → Log

    Returns a log object

    allows the user to read the log or clear it

  new(project_path: str) → None

    Creates a new project

    Arguments:

      project_path (`str`): Full path to the project data folder. If folder exists, it will fail

  open(project_path: str) → None

    Loads project from disk

    Arguments:

      project_path (`str`): Full path to the project data folder. If the project inside does not exist, it will fail.

  property parameters: dict
  property project_parameters: Parameters
  property zoning