Skip to main content
`Ctrl`+`K`

# aequilibrae.paths.SkimResults

class aequilibrae.paths.SkimResults

  Network skimming result holder.

      >>> from aequilibrae.paths.results import SkimResults

      >>> project = create_example(project_path)
      >>> project.network.build_graphs()

      # Mode c is car in this project
      >>> car_graph = project.network.graphs['c']

      # minimize travel time
      >>> car_graph.set_graph('free_flow_time')

      # Skims travel time and distance
      >>> car_graph.set_skimming(['free_flow_time', 'distance'])

      >>> res = SkimResults()
      >>> res.prepare(car_graph)

      >>> res.skims.export(os.path.join(project_path, "skim_matrices.aem"))

  __init__()

  Methods

  `__init__`() |
  `prepare`(graph) | Prepares the object with dimensions corresponding to the graph objects

  prepare(graph: Graph)

    Prepares the object with dimensions corresponding to the graph objects

    Arguments:

      graph (`Graph`): Needs to have been set with number of centroids and list of skims (if any)