admonitions

docs/source/examples/aequilibrae_without_a_model/plot_assignment_without_model.py

@@ -8,6 +8,20 @@
 
 We are using `Sioux Falls data <https://github.com/bstabler/TransportationNetworks/tree/master/SiouxFalls>`_, from TNTP.
 """
+# %%
+# .. admonition:: References
+# 
+#   * :ref:`static_traffic_assignment`
+
+# %%
+# .. seealso::
+#     Several functions, methods, classes and modules are used in this example:
+#
+#     * :func:`aequilibrae.paths.Graph`
+#     * :func:`aequilibrae.paths.TrafficClass`
+#     * :func:`aequilibrae.paths.TrafficAssignment` 
+#     * :func:`aequilibrae.matrix.AequilibraeMatrix`
+
 # %%
 
 # Imports
@@ -133,19 +147,3 @@
 # %%
 # And at the Assignment report
 assig.report()
-
-# %%
-# .. admonition:: References
-# 
-#   :ref:`aequilibrae-graphs`
-#   :ref:`traffic_assignment_procedure`
-#   :ref:`multiclass_equilibrium`
-
-# %%
-# .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
-#
-#     * :func:`aequilibrae.paths.Graph`
-#     * :func:`aequilibrae.paths.TrafficClass`
-#     * :func:`aequilibrae.paths.TrafficAssignment` 
-#     * :func:`aequilibrae.matrix.AequilibraeMatrix`

docs/source/examples/aequilibrae_without_a_model/plot_ipf_without_model.py

@@ -15,6 +15,19 @@
 `Ortúzar & Willumsen (2011) <https://www.wiley.com/en-us/Modelling+Transport%2C+4th+Edition-p-9780470760390>`_.
 
 """
+# %%
+# .. admonition:: References
+# 
+#   * :ref:`all_about_aeq_matrices` 
+#   * :ref:`validation`
+
+# %%
+# .. seealso::
+#     Several functions, methods, classes and modules are used in this example:
+#
+#     * :func:`aequilibrae.matrix.AequilibraeMatrix`
+#     * :func:`aequilibrae.matrix.AequilibraeData`
+#     * :func:`aequilibrae.distribution.Ipf`
 
 # %%
 
@@ -80,16 +93,3 @@
 for line in fratar.report:
     print(line)
 
-# %%
-# .. admonition:: References
-# 
-#   * :ref:`all_about_aeq_matrices` 
-#   * :ref:`validation`
-
-# %%
-# .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
-#
-#     * :func:`aequilibrae.matrix.AequilibraeMatrix`
-#     * :func:`aequilibrae.matrix.AequilibraeData`
-#     * :func:`aequilibrae.distribution.Ipf`

docs/source/examples/assignment_workflows/plot_forecasting.py

@@ -12,7 +12,7 @@
 """
 # %%
 # .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
+#     Several functions, methods, classes and modules are used in this example:
 #
 #     * :func:`aequilibrae.paths.Graph`
 #     * :func:`aequilibrae.paths.TrafficClass`

docs/source/examples/assignment_workflows/plot_public_transit_assignment.py

@@ -12,12 +12,11 @@
 # %%
 # .. admonition:: References
 # 
-#   * :ref:`transit_assignment_graph`
-#   * :ref:`transit_hyperpath_routing`
+#   * :ref:`transit_assignment`
 
 # %%
 # .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
+#     Several functions, methods, classes and modules are used in this example:
 #
 #     * :func:`aequilibrae.transit.Transit`
 #     * :func:`aequilibrae.transit.TransitGraphBuilder`

docs/source/examples/assignment_workflows/plot_route_choice_basics.py

@@ -10,11 +10,11 @@
 # %%
 # .. admonition:: References
 # 
-#   :ref:`route_choice`
+#   * :ref:`route_choice`
 
 # %%
 # .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
+#     Several functions, methods, classes and modules are used in this example:
 #
 #     * :func:`aequilibrae.paths.Graph`
 #     * :func:`aequilibrae.paths.RouteChoice`

docs/source/examples/assignment_workflows/plot_route_choice_set.py

@@ -10,11 +10,11 @@
 # %%
 # .. admonition:: References
 # 
-#   :ref:`route_choice`
+#   * :ref:`route_choice`
 
 # %%
 # .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
+#     Several functions, methods, classes and modules are used in this example:
 #
 #     * :func:`aequilibrae.paths.RouteChoice`
 

docs/source/examples/assignment_workflows/plot_subarea_analysis.py

@@ -9,10 +9,10 @@
 
 .. admonition:: References
  
-   :ref:`route_choice`
+   * :ref:`route_choice`
 
 .. seealso::
-    The use of the following functions, methods, classes and modules is shown in this example:
+    Several functions, methods, classes and modules are used in this example:
 
     * :func:`aequilibrae.paths.Graph`
     * :func:`aequilibrae.paths.RouteChoice`

docs/source/examples/creating_models/plot_create_from_gmns.py

@@ -8,6 +8,16 @@
 The source files of this network are publicly available in the 
 `GMNS GitHub repository <https://github.com/zephyr-data-specs/GMNS>`_ itself.
 """
+# %%
+# .. admonition:: References
+# 
+#   * :ref:`importing_from_gmns_file` 
+
+# %%
+# .. seealso::
+#     Several functions, methods, classes and modules are used in this example:
+#
+#     * :func:`aequilibrae.project.Network.create_from_gmns`
 
 # %%
 
@@ -125,14 +135,3 @@
 
 # %%
 project.close()
-
-# %%
-# .. admonition:: References
-# 
-#   * :ref:`importing_from_gmns_file` 
-
-# %%
-# .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
-#
-#     * :func:`aequilibrae.project.Network.create_from_gmns`

docs/source/examples/creating_models/plot_create_from_layer.py

@@ -11,6 +11,20 @@
 We use Folium to visualize the resulting network.
 """
 
+# %%
+# .. admonition:: References
+# 
+#   * :ref:`accessing_project_data`
+
+# %%
+# .. seealso::
+#     Several functions, methods, classes and modules are used in this example:
+#
+#     * :func:`aequilibrae.project.network.Links`
+#     * :func:`aequilibrae.project.network.Nodes` 
+#     * :func:`aequilibrae.project.network.Modes`
+#     * :func:`aequilibrae.project.network.LinkTypes` 
+
 # %%
 
 # Imports
@@ -143,17 +157,3 @@
 
 # %%
 project.close()
-
-# %%
-# .. admonition:: References
-# 
-#   * :ref:`accessing_project_data`
-
-# %%
-# .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
-#
-#     * :func:`aequilibrae.project.network.Links`
-#     * :func:`aequilibrae.project.network.Nodes` 
-#     * :func:`aequilibrae.project.network.Modes`
-#     * :func:`aequilibrae.project.network.LinkTypes` 

docs/source/examples/creating_models/plot_create_from_osm.py

@@ -6,8 +6,18 @@
 
 In this example, we show how to create an empty project and populate it with a network from OpenStreetMap.
 
-This time we will use Folium to visualize the network.
+This time we will use GeoPandas to visualize the network.
 """
+# %%
+# .. admonition:: References
+# 
+#   * :ref:`importing_from_osm` 
+
+# %%
+# .. seealso::
+#     Several functions, methods, classes and modules are used in this example:
+#
+#     * :func:`aequilibrae.project.Network.create_from_osm`
 
 # %%
 
@@ -54,14 +64,3 @@
 
 # %%
 project.close()
-
-# %%
-# .. admonition:: References
-# 
-#   * :ref:`importing_from_osm` 
-
-# %%
-# .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
-#
-#     * :func:`aequilibrae.project.Network.create_from_osm`

docs/source/examples/creating_models/plot_create_zoning.py

@@ -16,6 +16,17 @@
 you have the geometries for them. In that case, you can just skip the hex bin computation
 part of this notebook.
 """
+# %%
+# .. admonition:: References
+# 
+#   * :ref:`Accessing project zones <project_zoning>`
+
+# %%
+# .. seealso::
+#     Several functions, methods, classes and modules are used in this example:
+#
+#     * :func:`aequilibrae.project.Zoning`
+#     * :func:`aequilibrae.project.network.Nodes` 
 
 # %%
 
@@ -147,16 +158,3 @@
 
 # %%
 project.close()
-
-# %%
-# .. admonition:: References
-# 
-#   * :ref:`tables_zones` 
-#   * :ref:`Accessing project zones <project_zoning>`
-
-# %%
-# .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
-#
-#     * :func:`aequilibrae.project.Zoning`
-#     * :func:`aequilibrae.project.network.Nodes` 

docs/source/examples/creating_models/plot_import_gtfs.py

@@ -8,6 +8,12 @@
 
 We use data from Coquimbo, a city in La Serena Metropolitan Area in Chile.
 """
+# %%
+# .. seealso::
+#     Several functions, methods, classes and modules are used in this example:
+#
+#     * :func:`aequilibrae.transit.Transit`
+#     * :func:`aequilibrae.transit.lib_gtfs.GTFSRouteSystemBuilder`
 
 # %%
 
@@ -121,10 +127,3 @@
 
 # %%
 project.close()
-
-# %%
-# .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
-#
-#     * :func:`aequilibrae.transit.Transit`
-#     * :func:`aequilibrae.transit.lib_gtfs.GTFSRouteSystemBuilder`

docs/source/examples/editing_networks/plot_moving_link_extremity.py

@@ -7,6 +7,16 @@
 In this example, we move a link extremity from one point to another
 and see what happens to the network.
 """
+# %%
+# .. admonition:: References
+# 
+#   * :ref:`modifications_on_links_layer` 
+
+# %%
+# .. seealso::
+#     Several functions, methods, classes and modules are used in this example:
+#
+#     * :func:`aequilibrae.project.network.Links`
 
 # %%
 
@@ -75,14 +85,3 @@
 
 # %%
 project.close()
-
-# %%
-# .. admonition:: References
-# 
-#   * :ref:`modifications_on_links_layer` 
-
-# %%
-# .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
-#
-#     * :func:`aequilibrae.project.network.Links`

docs/source/examples/editing_networks/plot_moving_nodes.py

@@ -7,6 +7,16 @@
 In this example, we show how to mode a node in the network and look into
 what happens to the links.
 """
+# %%
+# .. admonition:: References
+# 
+#   * :ref:`modifications_on_nodes_layer` 
+
+# %%
+# .. seealso::
+#     Several functions, methods, classes and modules are used in this example:
+#
+#     * :func:`aequilibrae.project.network.Nodes`
 
 # %%
 
@@ -64,14 +74,3 @@
 
 # %%
 project.close()
-
-# %%
-# .. admonition:: References
-# 
-#   * :ref:`modifications_on_nodes_layer` 
-
-# %%
-# .. seealso::
-#     The use of the following functions, methods, classes and modules is shown in this example:
-#
-#     * :func:`aequilibrae.project.network.Nodes`