Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
r-akemii committed Sep 9, 2024
1 parent c183c6d commit 3b8dad2
Show file tree
Hide file tree
Showing 13 changed files with 30 additions and 21 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
--@ The *agencies* table holds information about the Public Transport
--@ agencies within the GTFS data. This table information comes from
--@ GTFS file *agency.txt*.
--@ You can check out more information `here <https://developers.google.com/transit/gtfs/reference#agencytxt>`_.
--@ You can check out more information
--@ `on agency table here <https://developers.google.com/transit/gtfs/reference#agencytxt>`_.
--@
--@ **agency_id** identifies the agency for the specified route
--@
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
--@ The *fare_attributes* table holds information about the fare values.
--@ This table information comes from the GTFS file *fare_attributes.txt*.
--@ Given that this file is optional in GTFS, it can be empty.
--@ You can check out more information `here <https://developers.google.com/transit/gtfs/reference#fare_attributestxt>`_.
--@ You can check out more information `on fare attributes here <https://developers.google.com/transit/gtfs/reference#fare_attributestxt>`_.
--@
--@ **fare_id** identifies a fare class
--@
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
--@ The *routes* table holds information on the available transit routes for a
--@ specific day. This table information comes from the GTFS file *routes.txt*.
--@ You can find more information about it `here <https://developers.google.com/transit/gtfs/reference#routestxt>`_.
--@ You can find more information about `the routes table here <https://developers.google.com/transit/gtfs/reference#routestxt>`_.
--@
--@ **pattern_id** is an unique pattern for the route
--@
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
--@ The *stops* table holds information on the stops where vehicles
--@ pick up or drop off riders. This table information comes from
--@ the GTFS file *stops.txt*. You can find more information about
--@ it `here <https://developers.google.com/transit/gtfs/reference#stopstxt>`_.
--@ `the stops table here <https://developers.google.com/transit/gtfs/reference#stopstxt>`_.
--@
--@ **stop_id** is an unique identifier for a stop
--@
Expand Down
11 changes: 9 additions & 2 deletions docs/source/examples/creating_models/plot_create_from_layer.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,16 @@
# %%
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`
# * :func:`aequilibrae.project.network.Links`
# * :func:`aequilibrae.project.network.Nodes`
# * :func:`aequilibrae.project.network.Modes`
# * :func:`aequilibrae.project.network.LinkTypes`
2 changes: 1 addition & 1 deletion docs/source/examples/creating_models/plot_create_zoning.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@
# .. admonition:: References
#
# * :ref:`tables_zones`
# * :ref:`project_zoning`
# * :ref:`Accessing project zones <project_zoning>`

# %%
# .. seealso::
Expand Down
3 changes: 2 additions & 1 deletion docs/source/examples/creating_models/plot_import_gtfs.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,5 @@
# .. 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`
# * :func:`aequilibrae.transit.Transit`
# * :func:`aequilibrae.transit.lib_gtfs.GTFSRouteSystemBuilder`
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,6 @@
# .. 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.matrix.AequilibraeMatrix`
# * :func:`aequilibrae.matrix.AequilibraeData`
# * :func:`aequilibrae.distribution.Ipf`
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,8 @@ def plot_tlfd(demand, skim, name):
# .. seealso::
# The use of the following functions, methods, classes and modules is shown in this example:
#
# * :func:`aequilibrae.distribution.Ipf` | :func:`aequilibrae.distribution.GravityCalibration`
# * :func:`aequilibrae.distribution.GravityApplication` | :func:`aequilibrae.distribution.SyntheticGravityModel`
# * :func:`aequilibrae.distribution.Ipf`
# * :func:`aequilibrae.distribution.GravityCalibration`
# * :func:`aequilibrae.distribution.GravityApplication`
# * :func:`aequilibrae.distribution.SyntheticGravityModel`
# * :func:`aequilibrae.matrix.AequilibraeData`
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ of iterations and target Relative Gap.

.. image:: ../../images/parameters_assignment_example.png
:align: center
:scale: 80 %
:alt: Assignment example

Although these parameters are required to exist in the parameters file, one can
Expand All @@ -33,6 +34,7 @@ synthetic gravity models, as shown below.

.. image:: ../../images/parameters_distribution_example.png
:align: center
:scale: 80 %
:alt: Distribution example

.. _parameters_network:
Expand Down Expand Up @@ -65,8 +67,8 @@ The data types available are those that exist within the
to the use of **integer**, **numeric** and **varchar**.

.. image:: ../../images/parameters_links_example.png
:width: 704
:align: center
:scale: 80 %
:alt: Link example

For the case of all non-mandatory fields, two more parameters are possible: 'osm_source' and
Expand All @@ -91,6 +93,7 @@ the allowed values for this parameter are **copy** and **divide**, as shown belo

.. image:: ../../images/parameters_links_osm_behaviour.png
:align: center
:scale: 80 %
:alt: OSM behaviour examples

The example below also shows that it is possible to mix fields that will be imported from
Expand Down Expand Up @@ -153,6 +156,7 @@ below.

.. image:: ../../images/parameters_system_example.png
:align: center
:scale: 80 %
:alt: System example

The number of CPUs have a special behaviour defined, as follows:
Expand All @@ -178,6 +182,7 @@ recommended to deploy a local Overpass server.

.. image:: ../../images/parameters_osm_example.png
:align: center
:scale: 80 %
:alt: OSM example

The user is also welcome to change the maximum area for a single query to the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
Periods table
=============

Lorem ipsum

.. seealso::

Lorem ipsum
* :func:`aequilibrae.project.network.Periods`

.. include:: data_model/periods.rst

Original file line number Diff line number Diff line change
Expand Up @@ -184,9 +184,6 @@ The use of the AequilibraE project and its built-in methods to build graphs
ensure that all graphs will be built in a consistent manner and multi-class
assignment is possible.

References
----------

.. [1] Wardrop J. G. (1952) "Some theoretical aspects of road traffic research."
Proceedings of the Institution of Civil Engineers 1952, 1(3):325-362.
Available in: https://www.icevirtuallibrary.com/doi/abs/10.1680/ipeds.1952.11259
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -466,9 +466,6 @@ apparent as we further increase :math:`\alpha`:

:func:`aequilibrae.paths.HyperpathGenerating`

References
----------

.. [1] Spiess, H., Florian, M. (1989) "Optimal strategies: A new assignment model for transit networks".
Transportation Research Part B: Methodological, 23(2), 83-102.
Available in: https://doi.org/10.1016/0191-2615(89)90034-9
Expand Down

0 comments on commit 3b8dad2

Please sign in to comment.