:orphan:

All Examples
============

This page contains all of AequilibraE's examples in just one place.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Examples
--------

AequilibraE Project
~~~~~~~~~~~~~~~~~~~


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to prevent Windows from downloading the SpatiaLite binaries automatically.">

.. only:: html

  .. image:: /_auto_examples/aequilibrae_project/images/thumb/sphx_glr_plot_avoiding_spatialite_download_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_aequilibrae_project_plot_avoiding_spatialite_download.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Avoiding the automatic download of SpatiaLite binaries on Windows</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to make all log messages show in the terminal.">

.. only:: html

  .. image:: /_auto_examples/aequilibrae_project/images/thumb/sphx_glr_plot_logging_to_terminal_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_aequilibrae_project_plot_logging_to_terminal.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Logging to terminal</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="AequilibraE&#x27;s log is a very useful tool to get more information about what the software is doing under the hood.">

.. only:: html

  .. image:: /_auto_examples/aequilibrae_project/images/thumb/sphx_glr_plot_check_logging_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_aequilibrae_project_plot_check_logging.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Checking AequilibraE's log</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Examples
--------

Distribution Procedures
~~~~~~~~~~~~~~~~~~~~~~~



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to use aequilibrae.distribution.ipf_core, a high-performance  alternative for all those who want to (re)balance values within a matrix making direct use of growth factors. ipf_core was built to suit countless applications rather than being limited to trip distribution.">

.. only:: html

  .. image:: /_auto_examples/distribution_procedures/images/thumb/sphx_glr_plot_ipf_core_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_distribution_procedures_plot_ipf_core.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Running IPF with NumPy array</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show you how to use AequilibraE&#x27;s IPF function without a model. This is a complement to the application in example_usage_forecasting.">

.. only:: html

  .. image:: /_auto_examples/distribution_procedures/images/thumb/sphx_glr_plot_ipf_without_model_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_distribution_procedures_plot_ipf_without_model.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Running IPF without an AequilibraE model</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Examples
--------

Network Manipulation
~~~~~~~~~~~~~~~~~~~~


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to create an empty project and populate it with a network from  OpenStreetMap.">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_create_from_osm_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_create_from_osm.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create project from OpenStreetMap</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to mode a node in the network and look into what happens to the links.">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_moving_nodes_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_moving_nodes.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Editing network geometry: Nodes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we export a simple network to GMNS format. The source AequilibraE model used as input for this is the result of the import process (``create_from_gmns()``) using the GMNS example of Arlington Signals, which can be found in the GMNS repository on GitHub: https://github.com/zephyr-data-specs/GMNS">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_export_to_gmns_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_export_to_gmns.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Exporting network to GMNS</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we move a link extremity from one point to another and see what happens to the network.">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_moving_link_extremity_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_moving_link_extremity.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Editing network geometry: Links</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to use Folium to plot a network for different modes.">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_display_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_display.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Exploring the network on a notebook</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we split a link right in the middle, while keeping all fields in the database equal. Distance is proportionally computed automatically in the database.">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_splitting_link_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_splitting_link.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Editing network geometry: Splitting link</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="We use Coquimbo example to show how we can create centroids and connect them to the existing network efficiently.">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_centroid_connection_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_centroid_connection.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create centroid connectors</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we import a simple network in GMNS format. The source files of this network are publicly available in the  GMNS GitHub repository itself.">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_create_from_gmns_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_create_from_gmns.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create project from GMNS</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to find disconnected links in an AequilibraE network.">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_find_disconnected_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_find_disconnected.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Finding disconnected links</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to create an empty project and populate it with a network coming from a link layer we load from a text file. It can easily be replaced with a different form of loading the data (GeoPandas, for example).">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_create_from_layer_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_create_from_layer.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create project from a link layer</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example we use Nauru network to show how one can simplify the network, merging short links into longer ones or turning links into nodes, and saving theses changes into the project.">

.. only:: html

  .. image:: /_auto_examples/network_manipulation/images/thumb/sphx_glr_plot_network_simplification_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_network_manipulation_plot_network_simplification.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Network simplifier</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Examples
--------

Other applcations
~~~~~~~~~~~~~~~~~


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to create AequilibraE&#x27;s famous Delaunay Lines, but in Python.">

.. only:: html

  .. image:: /_auto_examples/other_applications/images/thumb/sphx_glr_plot_delaunay_lines_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_other_applications_plot_delaunay_lines.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Creating Delaunay Lines</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to create hex bin zones covering an arbitrary area.">

.. only:: html

  .. image:: /_auto_examples/other_applications/images/thumb/sphx_glr_plot_create_zoning_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_other_applications_plot_create_zoning.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create a zone system based on Hex Bins</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Examples
--------

Path computation
~~~~~~~~~~~~~~~~~~


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we demonstrate how to create an AequilibraE Graph from an arbitrary network.">

.. only:: html

  .. image:: /_auto_examples/path_computation/images/thumb/sphx_glr_plot_graph_from_arbitrary_data_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_path_computation_plot_graph_from_arbitrary_data.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Graph from arbitrary data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to perform path computation for Coquimbo, a city in La Serena Metropolitan Area in Chile.">

.. only:: html

  .. image:: /_auto_examples/path_computation/images/thumb/sphx_glr_plot_path_computation_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_path_computation_plot_path_computation.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Path computation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to perform network skimming for Coquimbo, a city in La Serena Metropolitan Area in Chile.">

.. only:: html

  .. image:: /_auto_examples/path_computation/images/thumb/sphx_glr_plot_skimming_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_path_computation_plot_skimming.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Network skimming</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Examples
--------

Public Transport
~~~~~~~~~~~~~~~~


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we import a GTFS feed to our model and perform map matching. ">

.. only:: html

  .. image:: /_auto_examples/public_transport/images/thumb/sphx_glr_plot_import_gtfs_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_public_transport_plot_import_gtfs.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Import GTFS</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we build on the transit assignment example and add skimming to it.">

.. only:: html

  .. image:: /_auto_examples/public_transport/images/thumb/sphx_glr_plot_public_transit_skimming_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_public_transport_plot_public_transit_skimming.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Public transport assignment with skimming</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, perform a Spiess &amp; Florian assignment. Click here to check out the paper.">

.. only:: html

  .. image:: /_auto_examples/public_transport/images/thumb/sphx_glr_plot_public_transit_assignment_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_public_transport_plot_public_transit_assignment.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Public transport assignment with Optimal Strategies</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Examples
---------

Route Choice
~~~~~~~~~~~~~



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to generate route choice sets for estimation of route choice models, using a a city in La Serena Metropolitan Area in Chile.">

.. only:: html

  .. image:: /_auto_examples/route_choice/images/thumb/sphx_glr_plot_route_choice_set_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_route_choice_plot_route_choice_set.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Route Choice set generation</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to perform route choice set generation using BFSLE and Link penalisation, for a city in La Serena Metropolitan Area in Chile.">

.. only:: html

  .. image:: /_auto_examples/route_choice/images/thumb/sphx_glr_plot_route_choice_basics_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_route_choice_plot_route_choice_basics.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Route Choice</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to perform sub-area analysis using route choice assignment,  for a city in La Serena Metropolitan Area in Chile.">

.. only:: html

  .. image:: /_auto_examples/route_choice/images/thumb/sphx_glr_plot_subarea_analysis_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_route_choice_plot_subarea_analysis.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Route Choice with sub-area analysis</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Examples
---------

Run module
~~~~~~~~~~


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example we demonstrate how to use AequilibraE&#x27;s run module using Sioux Falls example.">

.. only:: html

  .. image:: /_auto_examples/run_module/images/thumb/sphx_glr_plot_run_module_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_run_module_plot_run_module.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Run module</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Examples
--------

Traffic assignment
~~~~~~~~~~~~~~~~~~



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Modern Activity-Based models (and even some trip-based and tour-based ones) result on incredibly sparse demand matrices, which opens up a significant opportunity to save time during assignment by using early-exiting during the path-computation phase of assignment.">

.. only:: html

  .. image:: /_auto_examples/traffic_assignment/images/thumb/sphx_glr_plot_sparse_matrix_assignment_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_traffic_assignment_plot_sparse_matrix_assignment.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Assigning sparse matrices</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we show how to perform Traffic Assignment in AequilibraE without a model.">

.. only:: html

  .. image:: /_auto_examples/traffic_assignment/images/thumb/sphx_glr_plot_assignment_without_model_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_traffic_assignment_plot_assignment_without_model.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Traffic Assignment without an AequilibraE Model</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="In this example, we present a full forecasting workflow for the Sioux Falls example model.">

.. only:: html

  .. image:: /_auto_examples/traffic_assignment/images/thumb/sphx_glr_plot_forecasting_thumb.png
    :alt:

  :ref:`sphx_glr__auto_examples_traffic_assignment_plot_forecasting.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Forecasting</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /_auto_examples/aequilibrae_project/index.rst
   /_auto_examples/distribution_procedures/index.rst
   /_auto_examples/network_manipulation/index.rst
   /_auto_examples/other_applications/index.rst
   /_auto_examples/path_computation/index.rst
   /_auto_examples/public_transport/index.rst
   /_auto_examples/route_choice/index.rst
   /_auto_examples/run_module/index.rst
   /_auto_examples/traffic_assignment/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: _auto_examples_python.zip </_auto_examples/_auto_examples_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: _auto_examples_jupyter.zip </_auto_examples/_auto_examples_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_