Merge branch 'feature_PuT_assignment' into integration

AequilibraE · Dec 14, 2023 · e6b56d3 · e6b56d3
2 parents 8f81c86 + 892b2b1
commit e6b56d3
Show file tree

Hide file tree

Showing 30 changed files with 1,186 additions and 128 deletions.
diff --git a/aequilibrae/paths/public_transport.pyx b/aequilibrae/paths/public_transport.pyx
@@ -33,8 +33,24 @@ class HyperpathGenerating:
             assignment_config: dict,
             check_edges: bool =False,
             check_demand: bool =False,
-            threads: int = -1
+            threads: int = 0
     ):
+        """A class for hyperpath generation.
+
+        :Arguments:
+            **graph** (:obj:`TransitGraph`): TransitGraph object
+
+            **matrix** (:obj:`AequilibraEMatrix`): AequilbraE Matrix object for the demand
+
+            **assignment_conffig** (:obj:`dict[str, str]`): Dictionary containing the `Time field` and `Frequency field` columns names.
+
+            **check_edges** (:obj:`bool`): If True, check the validity of the edges (optional, default is False).
+
+            **check_demand** (:obj:`bool`): If True, check the validity of the demand data (optional, default is False).
+
+            **threads** (:obj:`int`): The number of threads to use for computation (optional, default is 0, using all available threads).
+        """
+
         edges = graph.graph
         trav_time = assignment_config["Time field"]
         freq = assignment_config["Frequency field"]
@@ -167,7 +183,13 @@ class HyperpathGenerating:
             if edges[col].min() < 0.0:
                 raise ValueError(f"column '{col}' should be nonnegative")
 
-    def execute(self, threads=None):
+    def execute(self, threads=0):
+        """Assigns demand to the edges of the graph.
+
+        :Arguments:
+            **threads** (:obj:`int`):The number of threads to use for computation (optional, default is 0, using all available threads).
+        """
+
         # check the input demand paramater
         if not threads:
             threads = self.threads

diff --git a/aequilibrae/transit/__init__.py b/aequilibrae/transit/__init__.py
@@ -1 +1,2 @@
 from .transit import Transit
+from .transit_graph_builder import TransitGraphBuilder
diff --git a/aequilibrae/transit/transit.py b/aequilibrae/transit/transit.py
@@ -77,8 +77,7 @@ def create_transit_database(self):
     def create_graph(self, **kwargs) -> TransitGraphBuilder:
         period_id = kwargs.get("period_id", self.periods.default_period.period_id)
         graph = TransitGraphBuilder(self.pt_con, period_id, **kwargs)
-        graph.create_vertices()
-        graph.create_edges()
+        graph.create_graph()
         self.graphs[period_id] = graph
         return graph
 

diff --git a/aequilibrae/transit/transit_graph_builder.py b/aequilibrae/transit/transit_graph_builder.py
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -106,6 +106,7 @@ Paths
     VDF
     TrafficClass
     TrafficAssignment
+    HyperpathGenerating
 
 Transit
 -------
@@ -115,3 +116,5 @@ Transit
    :toctree: generated/
 
     Transit
+    SF_graph_builder
+
diff --git a/docs/source/images/hyperpath_bell_edge_base_delay.png b/docs/source/images/hyperpath_bell_edge_base_delay.png
diff --git a/docs/source/images/hyperpath_bell_edge_travel_time.png b/docs/source/images/hyperpath_bell_edge_travel_time.png
diff --git a/docs/source/images/hyperpath_bell_n_10_alpha_0d0.png b/docs/source/images/hyperpath_bell_n_10_alpha_0d0.png
diff --git a/docs/source/images/hyperpath_bell_n_10_alpha_0d5.png b/docs/source/images/hyperpath_bell_n_10_alpha_0d5.png
diff --git a/docs/source/images/hyperpath_bell_n_10_alpha_100d0.png b/docs/source/images/hyperpath_bell_n_10_alpha_100d0.png
diff --git a/docs/source/images/hyperpath_bell_n_10_alpha_1d0.png b/docs/source/images/hyperpath_bell_n_10_alpha_1d0.png
diff --git a/docs/source/images/hyperpath_bell_n_10_shartest_path.png b/docs/source/images/hyperpath_bell_n_10_shartest_path.png
diff --git a/docs/source/images/hyperpath_bell_s_network.png b/docs/source/images/hyperpath_bell_s_network.png
diff --git a/docs/source/images/transit_graph_connectors.png b/docs/source/images/transit_graph_connectors.png
diff --git a/docs/source/images/transit_graph_routes_1.png b/docs/source/images/transit_graph_routes_1.png
diff --git a/docs/source/images/transit_graph_routes_2.png b/docs/source/images/transit_graph_routes_2.png
diff --git a/docs/source/images/transit_graph_spiess_florian_1.png b/docs/source/images/transit_graph_spiess_florian_1.png
diff --git a/docs/source/images/transit_graph_spiess_florian_2.png b/docs/source/images/transit_graph_spiess_florian_2.png
diff --git a/docs/source/images/transit_graph_stop_anatomy.png b/docs/source/images/transit_graph_stop_anatomy.png
diff --git a/docs/source/images/transit_graph_stops_stations.png b/docs/source/images/transit_graph_stops_stations.png
diff --git a/docs/source/images/transit_graph_transfer_1.png b/docs/source/images/transit_graph_transfer_1.png
diff --git a/docs/source/images/transit_graph_transfer_2.png b/docs/source/images/transit_graph_transfer_2.png
diff --git a/docs/source/images/transit_graph_transfer_3.png b/docs/source/images/transit_graph_transfer_3.png
diff --git a/docs/source/images/transit_graph_transfer_links.png b/docs/source/images/transit_graph_transfer_links.png
diff --git a/docs/source/images/transit_graph_walking_links.png b/docs/source/images/transit_graph_walking_links.png
diff --git a/docs/source/images/transit_graph_zones.png b/docs/source/images/transit_graph_zones.png
diff --git a/docs/source/modeling_with_aequilibrae.rst b/docs/source/modeling_with_aequilibrae.rst
@@ -22,4 +22,4 @@ a start guide to a complete view into AequilibraE's data structure.
     modeling_with_aequilibrae/project_database
     modeling_with_aequilibrae/parameter_file
     modeling_with_aequilibrae/public_transport
-
+    modeling_with_aequilibrae/transit_assignment
diff --git a/docs/source/modeling_with_aequilibrae/transit_assignment.rst b/docs/source/modeling_with_aequilibrae/transit_assignment.rst
@@ -0,0 +1,11 @@
+.. _transit_assignment:
+
+Transit assignment
+==================
+
+
+.. toctree::
+    :maxdepth: 1
+
+    transit_assignment/hyperpath_routing.rst
+    transit_assignment/transit_graph.rst
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		from .transit import Transit
		from .transit_graph_builder import TransitGraphBuilder