Adds support to multiple transit agencies

.github/workflows/documentation.yml

@@ -57,7 +57,7 @@ jobs:
     - name: Build documentation
       run: |
         jupyter nbconvert --to rst docs/source/useful_information/validation_benchmarking/IPF_benchmark.ipynb
-        sphinx-build -M latexpdf docs/source docs/source/_static
+        # sphinx-build -M latexpdf docs/source docs/source/_static
         sphinx-build -b html docs/source docs/build
         python3 -m zipfile -c AequilibraE.zip docs/build
         cp AequilibraE.zip docs/source/_static

aequilibrae/project/database_specification/transit/tables/fare_attributes.sql

@@ -1,7 +1,8 @@
 --@ 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 `on fare attributes here <https://gtfs.org/documentation/schedule/reference/#fare_attributestxt>`_.
+--@ You can check out more information 
+--@ `on fare attributes here <https://gtfs.org/documentation/schedule/reference/#fare_attributestxt>`_.
 --@ 
 --@ **fare_id** identifies a fare class
 --@ 

aequilibrae/project/database_specification/transit/tables/fare_zones.sql

@@ -1,12 +1,15 @@
 --@ The *fare_zones* table hold information on the transit fare zones and
 --@ the transit agencies that operate in it.
 --@
---@ **transit_fare_zone** identifies the transit fare zones
+--@ **fare_zone_id** identifies the fare zone
+--@ 
+--@ **transit_zone** identifies the transit fare zones
 --@ 
 --@ **agency_id** identifies the agency/agencies for the specified fare zone
 
 CREATE TABLE IF NOT EXISTS fare_zones (
-	transit_fare_zone    TEXT    NOT NULL,
-	agency_id            INTEGER NOT NULL,
+	fare_zone_id    INTEGER  PRIMARY KEY,
+	transit_zone    TEXT,
+	agency_id       INTEGER,
 	FOREIGN KEY(agency_id) REFERENCES agencies(agency_id) deferrable initially deferred
 );

aequilibrae/project/database_specification/transit/tables/routes.sql

@@ -1,6 +1,7 @@
 --@ 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 `the routes table here <https://gtfs.org/documentation/schedule/reference/#routestxt>`_.
+--@ You can find more information about 
+--@ `the routes table here <https://gtfs.org/documentation/schedule/reference/#routestxt>`_.
 --@
 --@ **pattern_id** is an unique pattern for the route
 --@

aequilibrae/project/database_specification/transit/tables/stops.sql

@@ -21,11 +21,9 @@
 --@ 
 --@ **description** provides useful description of the stop location
 --@ 
---@ **street** identifies the address of a stop
+--@ **fare_zone_id** identifies the fare zone for a stop
 --@ 
---@ **zone_id** identifies the TAZ for a stop
---@ 
---@ **transit_fare_zone** identifies the transit fare zone for a stop
+--@ **transit_zone** identifies the transit fare zone for a stop
 --@ 
 --@ **route_type** indicates the type of transporation used on a route
 
@@ -38,11 +36,11 @@ CREATE TABLE IF NOT EXISTS stops (
 	name              TEXT,
 	parent_station    TEXT,
 	description       TEXT,
-	street            TEXT,
-	zone_id           INTEGER,
-	transit_fare_zone TEXT,
-	route_type        INTEGER NOT NULL DEFAULT -1,
-	FOREIGN KEY(agency_id) REFERENCES agencies(agency_id)
+	fare_zone_id      INTEGER,
+	transit_zone      TEXT,
+	route_type        INTEGER  NOT NULL DEFAULT -1,
+	FOREIGN KEY(agency_id) REFERENCES agencies(agency_id),
+	FOREIGN KEY("fare_zone_id") REFERENCES fare_zones("fare_zone_id")
 );
 
 --#

aequilibrae/transit/column_order.py

@@ -7,10 +7,10 @@
             ("agency_name", str),
             ("agency_url", str),
             ("agency_timezone", str),
-            ("agency_lang", str),
-            ("agency_phone", str),
-            ("agency_fare_url", str),
-            ("agency_email", str),
+            # ("agency_lang", str),
+            # ("agency_phone", str),
+            # ("agency_fare_url", str),
+            # ("agency_email", str),
         ]
     ),
     "routes.txt": OrderedDict(
@@ -24,7 +24,7 @@
             # ("route_color", str),
             # ("route_text_color", str),
             # ("route_sort_order", int),
-            # ("agency_id", str),
+            ("agency_id", str),
         ]
     ),
     "trips.txt": OrderedDict(
@@ -76,7 +76,7 @@
             ("currency_type", str),
             ("payment_method", int),
             ("transfers", int),
-            # ("agency_id", str),
+            ("agency_id", str),
             ("transfer_duration", float),
         ]
     ),
@@ -113,13 +113,14 @@
             ("stop_desc", str),
             ("stop_lat", float),
             ("stop_lon", float),
-            ("stop_street", str),
             ("zone_id", str),
             # ("stop_url", str),
             # ("location_type", int),
             ("parent_station", str),
             # ("stop_timezone", str),
             # ("wheelchair_boarding", int),
+            # ("level_id", int),
+            # ("platform_code", str)
         ]
     ),
     "shapes.txt": OrderedDict(

aequilibrae/transit/constants.py

@@ -9,6 +9,7 @@
 WALK_LINK_RANGE = 30000000
 TRANSIT_LINK_RANGE = 20000000
 WALK_AGENCY_ID = 1
+STOP_ID = 1
 
 # 1 for right, -1 for wrong (left)
 DRIVING_SIDE = 1
@@ -21,7 +22,7 @@ class Constants:
     trips: Dict[int, int] = {}
     patterns: Dict[int, int] = {}
     pattern_lookup: Dict[int, int] = {}
-    stops: Dict[int, int] = {}
+    stops: Dict[int, Any] = {}
     fares: Dict[int, int] = {}
     links: Dict[int, int] = {}
     transit_links: Dict[int, int] = {}

aequilibrae/transit/gtfs_loader.py

@@ -31,7 +31,7 @@ def __init__(self):
         self.__pces__ = {}
         self.__max_speeds__ = {}
         self.feed_date = ""
-        self.agency = Agency()
+        self.agency: Dict[int, Agency] = {}
         self.services = {}
         self.routes: Dict[int, Route] = {}
         self.trips: Dict[int, Dict[Route]] = {}
@@ -46,6 +46,7 @@ def __init__(self):
         self.wgs84 = pyproj.Proj("epsg:4326")
         self.srid = get_srid()
         self.transformer = Transformer.from_crs("epsg:4326", f"epsg:{self.srid}", always_xy=False)
+        self.agency_correspondence = {}
         self.logger = get_logger()
 
     def set_feed_path(self, file_path):
@@ -75,21 +76,24 @@ def _set_pces(self, pces: dict):
     def _set_maximum_speeds(self, max_speeds: dict):
         self.__max_speeds__ = max_speeds
 
-    def load_data(self, service_date: str):
+    def load_data(self, service_date: str, description: str):
         """Loads the data for a respective service date.
 
         :Arguments:
             **service_date** (:obj:`str`): service date. e.g. "2020-04-01".
         """
-        ag_id = self.agency.agency
-        self.logger.info(f"Loading data for {service_date} from the {ag_id} GTFS feed. This may take some time")
+        self.service_date = service_date
+        self.description = description
+        self.logger.info(f"Loading data for {self.service_date} from the GTFS feed. This may take some time")
 
         self.__load_date()
 
     def __load_date(self):
         self.logger.debug("Starting __load_date")
         self.zip_archive = zipfile.ZipFile(self.archive_dir)
 
+        self.__load_agencies()
+
         self.signal.emit(["start", 7, "Loading routes"])
         self.__load_routes_table()
 
@@ -207,13 +211,19 @@ def __load_fare_data(self):
                 fareatt = parse_csv(file, column_order[fareatttxt])
             self.data_arrays[fareatttxt] = fareatt
 
+            existing_agencies = np.unique(fareatt["agency_id"])
+            if existing_agencies.shape[0] != len(self.agency):
+                self.logger.debug("agency_id exists on fare_attributes.txt but not in agency.txt")
+            elif existing_agencies.shape[0] == 1 and existing_agencies[0] == "":
+                fareatt["agency_id"] = list(self.agency.keys())[0]
+
             for line in range(fareatt.shape[0]):
                 data = tuple(fareatt[line][list(column_order[fareatttxt].keys())])
                 headers = ["fare_id", "price", "currency", "payment_method", "transfer", "transfer_duration"]
-                f = Fare(self.agency.agency_id)
+                f = Fare(fareatt[line]["agency_id"])
                 f.populate(data, headers)
                 if f.fare in self.fare_attributes:
-                    self.__fail(f"Fare ID {f.fare} for {self.agency.agency} is duplicated")
+                    self.__fail(f"Fare ID {f.fare} for {fareatt[line]['agency_id']} is duplicated")
                 self.fare_attributes[f.fare] = f
 
         farerltxt = "fare_rules.txt"
@@ -227,23 +237,16 @@ def __load_fare_data(self):
             farerl = parse_csv(file, column_order[farerltxt])
         self.data_arrays[farerltxt] = farerl
 
-        corresp = {}
-        zone_id = self.agency.agency_id * AGENCY_MULTIPLIER + 1
         for line in range(farerl.shape[0]):
             data = tuple(farerl[line][list(column_order[farerltxt].keys())])
             fr = FareRule()
             fr.populate(data, ["fare", "route", "origin", "destination", "contains"])
             fr.fare_id = self.fare_attributes[fr.fare].fare_id
             if fr.route in self.routes:
                 fr.route_id = self.routes[fr.route].route_id
-            fr.agency_id = self.agency.agency_id
-            for x in [fr.origin, fr.destination]:
-                if x not in corresp:
-                    corresp[x] = zone_id
-                    zone_id += 1
-            fr.origin_id = corresp[fr.origin]
-            fr.destination_id = corresp[fr.destination] if fr.destination == "" else fr.destination_id
-            self.fare_rules.append(fr) if fr.origin == "" else fr.origin_id
+            fr.origin_id = None if fr.origin == "" else int(fr.origin)
+            fr.destination_id = None if fr.destination == "" else int(fr.destination)
+            self.fare_rules.append(fr)
 
     def __load_shapes_table(self):
         self.logger.debug("Starting __load_shapes_table")
@@ -331,6 +334,7 @@ def __load_trips_table(self):
                 trip.source_time = list(stop_times.source_time.values)
                 self.logger.debug(f"{trip.trip} has {len(trip.stops)} stops")
                 trip._stop_based_shape = LineString([self.stops[x].geo for x in trip.stops])
+
                 # trip.shape = self.shapes.get(trip.shape)
                 trip.pce = self.routes[trip.route].pce
                 trip.seated_capacity = self.routes[trip.route].seated_capacity
@@ -444,8 +448,7 @@ def __load_stops_table(self):
         stops[:]["stop_lon"][:] = lons[:]
 
         for i, line in enumerate(stops):
-            s = Stop(self.agency.agency_id, line, stops.dtype.names)
-            s.agency = self.agency.agency
+            s = Stop(line, stops.dtype.names)
             s.srid = self.srid
             s.get_node_id()
             self.stops[s.stop_id] = s
@@ -474,8 +477,11 @@ def __load_routes_table(self):
         for route_type, pce in self.__pces__.items():
             routes.loc[routes.route_type == route_type, ["pce"]] = pce
 
+        agency_finder = routes["agency_id"].values.tolist()
+        routes.drop(columns="agency_id", inplace=True)
+
         for i, line in routes.iterrows():
-            r = Route(self.agency.agency_id)
+            r = Route(self.agency_correspondence[agency_finder[i]])
             r.populate(line.values, routes.columns)
             self.routes[r.route] = r
 
@@ -572,6 +578,25 @@ def __load_feed_calendar(self):
         if exception_inconsistencies:
             self.logger.info("    Minor inconsistencies found between calendar.txt and calendar_dates.txt")
 
+    def __load_agencies(self):
+        self.logger.debug("Starting __load_agencies")
+        agencytxt = "agency.txt"
+
+        self.logger.debug('    Loading "agency" table')
+        self.agency = {}
+        with self.zip_archive.open(agencytxt, "r") as file:
+            agencies = parse_csv(file, column_order[agencytxt])
+        self.data_arrays[agencytxt] = agencies
+
+        for i, line in enumerate(agencies):
+            a = Agency()
+            a.agency = line["agency_name"]
+            a.feed_date = self.feed_date
+            a.service_date = self.service_date
+            a.description = self.description
+            self.agency[a.agency_id] = a
+            self.agency_correspondence[line["agency_id"]] = a.agency_id
+
     def __fail(self, msg: str) -> None:
         self.logger.error(msg)
         raise Exception(msg)