scgraph 2.1.0__tar.gz → 2.1.2__tar.gz

{scgraph-2.1.0/scgraph.egg-info → scgraph-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scgraph
-Version: 2.1.0
+Version: 2.1.2
 Summary: Determine an approximate route between two points on earth.
 Author-email: Connor Makowski <conmak@mit.edu>
 Project-URL: Homepage, https://github.com/connor-makowski/scgraph

{scgraph-2.1.0 → scgraph-2.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.black]
 line-length = 80
-target-version = ['py39']
+target-version = ['py312']
 exclude = '/.*(migrations|__pycache__|geographs).*/'
 
 [tool.setuptools]
@@ -12,7 +12,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scgraph"
-version = "2.1.0"
+version = "2.1.2"
 description = "Determine an approximate route between two points on earth."
 authors = [
     {name="Connor Makowski", email="conmak@mit.edu"}

{scgraph-2.1.0 → scgraph-2.1.2}/scgraph/core.py

@@ -298,7 +298,7 @@ class Graph:
 
 class GeoGraph:
     def __init__(
-        self, graph: list[dict], nodes: list[list[int | float]]
+        self, graph: list[dict], nodes: list[list[int, float]]
     ) -> None:
         """
         Function:
@@ -397,17 +397,17 @@ class GeoGraph:
 
     def get_shortest_path(
         self,
-        origin_node: dict[int | float],
-        destination_node: dict[int | float],
+        origin_node: dict[int, float],
+        destination_node: dict[int, float],
         output_units: str = "km",
         algorithm_fn=Graph.dijkstra_makowski,
-        off_graph_circuity: float | int = 1,
+        off_graph_circuity: [int, float] = 1,
         node_addition_type: str = "quadrant",
-        node_addition_circuity: float | int = 4,
+        node_addition_circuity: [int, float] = 4,
         geograph_units: str = "km",
         output_coordinate_path: str = "list_of_lists",
         output_path: bool = False,
-        node_addition_lat_lon_bound: float | int = 5,
+        node_addition_lat_lon_bound: [int, float] = 5,
         node_addition_math: str = "euclidean",
         **kwargs,
     ) -> dict:
@@ -453,7 +453,7 @@ class GeoGraph:
                     - `origin`: The id of the origin node from the graph dictionary to start the shortest path from
                     - `destination`: The id of the destination node from the graph dictionary to end the shortest path at
         - `off_graph_circuity`
-            - Type: float | int
+            - Type: int | float
             - What: The circuity factor to apply to any distance calculations between your origin and destination nodes and their connecting nodes in the graph
             - Default: 1
             - Notes:
@@ -476,7 +476,7 @@ class GeoGraph:
                 - If the passed graph is not a connected graph (meaning it is comprised of multiple disconnected networks)
                     - The entrypoints generated using the `node_addition_type` will determine which disconnected networks will be used to calculate the `optimal route`
         - `node_addition_circuity`
-            - Type: float | int
+            - Type: int | float
             - What: The circuity factor to apply when adding your origin and destination nodes to the distance matrix
             - Default: 4
             - Note:
@@ -507,7 +507,7 @@ class GeoGraph:
             - What: Whether to output the path as a list of geograph node ids (for debugging and other advanced uses)
             - Default: False
         - `node_addition_lat_lon_bound`
-            - Type: float | int
+            - Type: int | float
             - What: Forms a bounding box around the origin and destination nodes as they are added to graph
                 - Only points on the current graph inside of this bounding box are considered when updating the distance matrix for the origin or destination nodes
             - Default: 5
@@ -596,10 +596,10 @@ class GeoGraph:
             - Type: dict
             - What: The output from the algorithm function
         - `node_addition_circuity`
-            - Type: float | int
+            - Type: int | float
             - What: The circuity factor that was applied when adding your origin and destination nodes to the distance matrix
         - `off_graph_circuity`
-            - Type: float | int
+            - Type: int | float
             - What: The circuity factor to apply to any distance calculations between your origin and destination nodes and their connecting nodes in the graph
         """
         coordinate_path = output["coordinate_path"]
@@ -619,7 +619,7 @@ class GeoGraph:
                 4,
             )
 
-    def get_coordinate_path(self, path: list[int]) -> list[dict[int | float]]:
+    def get_coordinate_path(self, path: list[int]) -> list[dict[int, float]]:
         """
         Function:
 
@@ -663,11 +663,11 @@ class GeoGraph:
     def get_node_distances(
         self,
         node: list,
-        circuity: int | float,
+        circuity: [int, float],
         node_addition_type: str,
         node_addition_math: str,
-        lat_lon_bound: int | float,
-    ) -> dict[int | float]:
+        lat_lon_bound: [int, float],
+    ) -> dict[int, float]:
         """
         Function:
 
@@ -681,7 +681,7 @@ class GeoGraph:
             - What: A list of the latitude and longitude of the node
             - EG: [latitude, longitude] -> [31.23, 121.47]
         - `circuity`
-            - Type: float | int
+            - Type: int | float
             - What: The circuity to apply to any distance calculations
             - Note: This defaults to 4 to prevent the algorithm from taking a direct route in direction of the destination over some impassible terrain (EG: a maritime network that goes through land)
         - `node_addition_type`
@@ -705,7 +705,7 @@ class GeoGraph:
             - Notes:
                 - Once the closest node (or closest quadrant node) is determined, the haversine distance (with circuity) is used to calculate the distance between the nodes when adding it to the graph.
         - `lat_lon_bound`
-            - Type: float | int
+            - Type: int | float
             - What: Forms a bounding box around the node that is to be added to graph. Only selects graph nodes to consider joining that are within this bounding box.
         """
         assert node_addition_type in [
@@ -727,7 +727,7 @@ class GeoGraph:
         if len(nodes) == 0:
             # Default to all if the lat_lon_bound fails to find any nodes
             return self.get_node_distances(
-                node=nodes,
+                node=node,
                 circuity=circuity,
                 lat_lon_bound=180,
                 node_addition_type=node_addition_type,
@@ -767,11 +767,11 @@ class GeoGraph:
 
     def add_node(
         self,
-        node: dict[int | float],
-        circuity: int | float,
+        node: dict[int, float],
+        circuity: [int, float],
         node_addition_type: str = "quadrant",
         node_addition_math: str = "euclidean",
-        lat_lon_bound: int | float = 5,
+        lat_lon_bound: [int, float] = 5,
     ) -> int:
         """
         Function:
@@ -788,7 +788,7 @@ class GeoGraph:
         Optional Arguments:
 
         - `circuity`
-            - Type: float | int
+            - Type: int | float
             - What: The circuity to apply to any distance calculations
             - Default: 4
             - Note: This defaults to 4 to prevent the algorithm from taking a direct route in direction of the destination over some impassible terrain (EG: a maritime network that goes through land)
@@ -814,7 +814,7 @@ class GeoGraph:
             - Notes:
                 - Once the closest node (or closest quadrant node) is determined, the haversine distance (with circuity) is used to calculate the distance between the nodes when adding it to the graph.
         - `lat_lon_bound`
-            - Type: float | int
+            - Type: int | float
             - What: Forms a bounding box around the node that is to be added to graph. Only selects graph nodes to consider joining that are within this bounding box.
             - Default: 5
 
@@ -843,7 +843,6 @@ class GeoGraph:
             lat_lon_bound, (int, float)
         ), "Lat_lon_bound must be a number"
         assert lat_lon_bound > 0, "Lat_lon_bound must be greater than 0"
-
         node = [node["latitude"], node["longitude"]]
         # Get the distances to all other nodes
         distances = self.get_node_distances(

{scgraph-2.1.0 → scgraph-2.1.2}/scgraph/utils.py

@@ -5,7 +5,7 @@ def haversine(
     origin: list[float, int],
     destination: list[float, int],
     units: str = "km",
-    circuity: int | float = 1,
+    circuity: [int, float] = 1,
 ):
     """
     Function:
@@ -28,7 +28,7 @@ def haversine(
         - What: units to return the distance in? (one of "km", "m", "mi", or "ft")
         - Default: "km"
     - `circuity`:
-        - Type: float | int
+        - Type: int | float
         - What: Multiplier to increase the calculated distance (to account for circuity)
         - Default: 1
 
@@ -69,7 +69,7 @@ def haversine(
         raise Exception()
 
 
-def hard_round(decimal_places: int, a: int | float):
+def hard_round(decimal_places: int, a: [int, float]):
     """
     Function:
 
@@ -81,7 +81,7 @@ def hard_round(decimal_places: int, a: int | float):
         - Type: int
         - What: number of decimal places to round to
     - `a`:
-        - Type: float | int
+        - Type: int | float
         - What: number to round
     """
     return int(a * (10**decimal_places) + (0.5 if a > 0 else -0.5)) / (
@@ -90,7 +90,7 @@ def hard_round(decimal_places: int, a: int | float):
 
 
 def distance_converter(
-    distance: int | float, input_units: str, output_units: str
+    distance: [int, float], input_units: str, output_units: str
 ):
     """
     Function:
@@ -115,7 +115,7 @@ def distance_converter(
     return (distance / km_table[input_units]) * km_table[output_units]
 
 
-def get_line_path(output: list | dict, filename=None):
+def get_line_path(output: [list, dict], filename=None):
     """
     Function:
 

{scgraph-2.1.0 → scgraph-2.1.2/scgraph.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scgraph
-Version: 2.1.0
+Version: 2.1.2
 Summary: Determine an approximate route between two points on earth.
 Author-email: Connor Makowski <conmak@mit.edu>
 Project-URL: Homepage, https://github.com/connor-makowski/scgraph

{scgraph-2.1.0 → scgraph-2.1.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = scgraph
-version = 2.1.0
+version = 2.1.2
 description_file = README.md
 
 [options]