scgraph 3.2.4__tar.gz → 3.4.0__tar.gz

{scgraph-3.2.4 → scgraph-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scgraph
-Version: 3.2.4
+Version: 3.4.0
 Summary: Determine an approximate distance and route between two points on earth.
 Author-Email: Connor Makowski <conmak@mit.edu>
 License-Expression: MIT
@@ -10,10 +10,20 @@ Classifier: Operating System :: OS Independent
 Project-URL: Homepage, https://github.com/connor-makowski/scgraph
 Project-URL: Bug Tracker, https://github.com/connor-makowski/scgraph/issues
 Project-URL: Documentation, https://connor-makowski.github.io/scgraph/scgraph.html
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Requires-Dist: geokdtree==1.2.3
-Requires-Dist: bmsspy<3.0.0,>=2.2.0
+Requires-Dist: bmsspy<3.0.0,>=2.2.1
 Requires-Dist: requests<3.0.0,>=2.32.0
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0.3; extra == "dev"
+Requires-Dist: pamda>=2.10.0; extra == "dev"
+Requires-Dist: autoflake>=2.3.1; extra == "dev"
+Requires-Dist: black>=25.1.0; extra == "dev"
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: nox>=2026.4.10; extra == "dev"
+Requires-Dist: nox-uv>=0.8.0; extra == "dev"
+Requires-Dist: pdoc>=15.0.1; extra == "dev"
+Requires-Dist: twine>=6.1.0; extra == "dev"
 Description-Content-Type: text/markdown
 
 # SCGraph
@@ -733,17 +743,22 @@ dist_mi = distance_converter(dist_km, input_units='km', output_units='mi')
 
 # Development
 
-Make sure Docker is installed and running on a Unix system (Linux, macOS, WSL2).
+Dev dependencies are declared in `[project.optional-dependencies] dev` in `pyproject.toml`. Install them with:
+
+```bash
+uv sync --extra dev
+```
 
 | Command | Description |
 |---|---|
-| `./run.sh` | Create a Docker container and drop into a shell |
-| `./run.sh test` | Run all tests |
-| `./run.sh test test/01_graph_basic_test.py` | Run a specific test file |
-| `./run.sh prettify` | Prettify the code |
-| `./run.sh docs` | Update the docs |
-
-You can modify the `Dockerfile` to test against different Python versions.
+| `uv run pytest` | Run all tests |
+| `uv run pytest test/NN_*.py` | Run a specific test file |
+| `uv run nox` | Run tests (C++ then no-C++) across Python 3.11–3.14 |
+| `uv run nox -s tests-3.14` | Run both build variants on a single Python version |
+| `uv run utils/benchmark.py` | Run all benchmarks, output `benchmark_results.json` |
+| `uv run utils/prettify.py` | Format with autoflake + black |
+
+For full developer documentation see [DEVELOPMENT.md](DEVELOPMENT.md).
 
 ---
 

{scgraph-3.2.4 → scgraph-3.4.0}/README.md

@@ -715,17 +715,22 @@ dist_mi = distance_converter(dist_km, input_units='km', output_units='mi')
 
 # Development
 
-Make sure Docker is installed and running on a Unix system (Linux, macOS, WSL2).
+Dev dependencies are declared in `[project.optional-dependencies] dev` in `pyproject.toml`. Install them with:
+
+```bash
+uv sync --extra dev
+```
 
 | Command | Description |
 |---|---|
-| `./run.sh` | Create a Docker container and drop into a shell |
-| `./run.sh test` | Run all tests |
-| `./run.sh test test/01_graph_basic_test.py` | Run a specific test file |
-| `./run.sh prettify` | Prettify the code |
-| `./run.sh docs` | Update the docs |
-
-You can modify the `Dockerfile` to test against different Python versions.
+| `uv run pytest` | Run all tests |
+| `uv run pytest test/NN_*.py` | Run a specific test file |
+| `uv run nox` | Run tests (C++ then no-C++) across Python 3.11–3.14 |
+| `uv run nox -s tests-3.14` | Run both build variants on a single Python version |
+| `uv run utils/benchmark.py` | Run all benchmarks, output `benchmark_results.json` |
+| `uv run utils/prettify.py` | Format with autoflake + black |
+
+For full developer documentation see [DEVELOPMENT.md](DEVELOPMENT.md).
 
 ---
 

{scgraph-3.2.4 → scgraph-3.4.0}/pyproject.toml

@@ -26,20 +26,40 @@ include = [
 
 [project]
 name = "scgraph"
-version = "3.2.4"
+version = "3.4.0"
 description = "Determine an approximate distance and route between two points on earth."
 authors = [
     {name="Connor Makowski", email="conmak@mit.edu"}
 ]
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 license="MIT"
 classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: C++",
     "Operating System :: OS Independent",
 ]
-dependencies = ["geokdtree==1.2.3","bmsspy>=2.2.0,<3.0.0","requests>=2.32.0,<3.0.0"]
+dependencies = ["geokdtree==1.2.3","bmsspy>=2.2.1,<3.0.0","requests>=2.32.0,<3.0.0"]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=9.0.3",
+    "pamda>=2.10.0",
+    "autoflake>=2.3.1",
+    "black>=25.1.0",
+    "build>=1.2.2",
+    "nox>=2026.4.10",
+    "nox-uv>=0.8.0",
+    "pdoc>=15.0.1",
+    "twine>=6.1.0",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["test"]
+pythonpath = ["test"]
+
+[tool.uv]
+no-build-isolation-package = []
 
 [project.urls]
 "Homepage" = "https://github.com/connor-makowski/scgraph"

{scgraph-3.2.4 → scgraph-3.4.0}/scgraph/__init__.py

@@ -716,23 +716,29 @@ dist_mi = distance_converter(dist_km, input_units='km', output_units='mi')
 
 # Development
 
-Make sure Docker is installed and running on a Unix system (Linux, macOS, WSL2).
+Dev dependencies are declared in `[project.optional-dependencies] dev` in `pyproject.toml`. Install them with:
+
+```bash
+uv sync --extra dev
+```
 
 | Command | Description |
 |---|---|
-| `./run.sh` | Create a Docker container and drop into a shell |
-| `./run.sh test` | Run all tests |
-| `./run.sh test test/01_graph_basic_test.py` | Run a specific test file |
-| `./run.sh prettify` | Prettify the code |
-| `./run.sh docs` | Update the docs |
+| `uv run pytest` | Run all tests |
+| `uv run pytest test/NN_*.py` | Run a specific test file |
+| `uv run nox` | Run tests (C++ then no-C++) across Python 3.11–3.14 |
+| `uv run nox -s tests-3.14` | Run both build variants on a single Python version |
+| `uv run utils/benchmark.py` | Run all benchmarks, output `benchmark_results.json` |
+| `uv run utils/prettify.py` | Format with autoflake + black |
 
-You can modify the `Dockerfile` to test against different Python versions.
+For full developer documentation see [DEVELOPMENT.md](DEVELOPMENT.md).
 
 ---
 
 ## Attributions and Thanks
 
 Originally inspired by [searoute](https://github.com/genthalili/searoute-py), including the use of one of their [datasets](https://github.com/genthalili/searoute-py/blob/main/searoute/data/marnet_densified_v2_old.geojson) that has been modified to work with this package.
+
 """
 
 try:
@@ -740,5 +746,7 @@ try:
 except ImportError:
     from scgraph.graph import Graph
     from scgraph.contraction_hierarchies import CHGraph
+    
 from scgraph.geograph import GeoGraph
 from scgraph.grid import GridGraph
+

{scgraph-3.2.4 → scgraph-3.4.0}/scgraph/geograph.py

@@ -737,6 +737,107 @@ class GeoGraphModifiers:
             symmetric=symmetric,
         )
 
+    def add_coord_edge(
+        self,
+        origin_coord_dict: dict[str, float | int],
+        destination_coord_dict: dict[str, float | int],
+        symmetric: bool = True,
+        distance: float | int | None = None,
+        circuity: float | int = 1,
+    ) -> None:
+        """
+        Function:
+
+        - Add an edge to the graph between two nodes specified by their coordinates
+        - Finds the closest nodes in the graph to the provided coordinates and adds an edge between them
+
+        Required Arguments:
+
+        - `origin_coord_dict`
+            - Type: dict
+            - What: A dictionary with the keys 'latitude' and 'longitude' for the origin node
+            - Note: The function will find the closest node in the graph to these coordinates and use that as the origin node for the edge
+        - `destination_coord_dict`
+            - Type: dict
+            - What: A dictionary with the keys 'latitude' and 'longitude' for the destination node
+            - Note: The function will find the closest node in the graph to these coordinates and use that as the destination node for the edge
+
+        Optional Arguments:
+
+        - `symmetric`
+            - Type: bool
+            - What: Whether to add the edge in both directions
+            - Default: True
+        - `distance`
+            - Type: int | float | None
+            - What: The distance to use for the edge. If None, the haversine distance between the origin and destination nodes (the closest nodes to the provided ones) will be used (with circuity applied)
+            - Default: None
+        - `circuity`
+            - Type: int | float
+            - What: The circuity to apply to the distance calculation if distance is None
+            - Default: 1
+        """
+        assert isinstance(
+            origin_coord_dict, dict
+        ), "Origin node must be a dictionary"
+        assert isinstance(
+            destination_coord_dict, dict
+        ), "Destination node must be a dictionary"
+        assert (
+            "latitude" in origin_coord_dict.keys()
+        ), "Origin node must have a latitude"
+        assert (
+            "longitude" in origin_coord_dict.keys()
+        ), "Origin node must have a longitude"
+        assert (
+            "latitude" in destination_coord_dict.keys()
+        ), "Destination node must have a latitude"
+        assert (
+            "longitude" in destination_coord_dict.keys()
+        ), "Destination node must have a longitude"
+        assert (
+            origin_coord_dict["latitude"] >= -90
+            and origin_coord_dict["latitude"] <= 90
+        ), "Origin latitude must be between -90 and 90"
+        assert (
+            origin_coord_dict["longitude"] >= -180
+            and origin_coord_dict["longitude"] <= 180
+        ), "Origin longitude must be between -180 and 180"
+        assert (
+            destination_coord_dict["latitude"] >= -90
+            and destination_coord_dict["latitude"] <= 90
+        ), "Destination latitude must be between -90 and 90"
+        assert (
+            destination_coord_dict["longitude"] >= -180
+            and destination_coord_dict["longitude"] <= 180
+        ), "Destination longitude must be between -180 and 180"
+        origin_node = [
+            origin_coord_dict["latitude"],
+            origin_coord_dict["longitude"],
+        ]
+        destination_node = [
+            destination_coord_dict["latitude"],
+            destination_coord_dict["longitude"],
+        ]
+        closest_origin_idx = self.geokdtree.closest_idx(point=origin_node)
+        closest_destination_idx = self.geokdtree.closest_idx(
+            point=destination_node
+        )
+        if distance is None:
+            distance = (
+                haversine(
+                    self.nodes[closest_origin_idx],
+                    self.nodes[closest_destination_idx],
+                )
+                * circuity
+            )
+        self.add_edge(
+            origin_id=closest_origin_idx,
+            destination_id=closest_destination_idx,
+            distance=distance,
+            symmetric=symmetric,
+        )
+
     def add_coord_node(
         self,
         coord_dict: dict[str, float | int],
@@ -819,7 +920,7 @@ class GeoGraphModifiers:
         ), "Longitude must be between -180 and 180"
         node = [coord_dict["latitude"], coord_dict["longitude"]]
         if auto_edge:
-            assert circuity > 1, "Circuity must be greater than 1"
+            assert circuity >= 1, "Circuity must be greater than or equal to 1"
             assert node_addition_type in [
                 "quadrant",
                 "all",
@@ -901,8 +1002,8 @@ class GeoGraphModifiers:
             self.graph_object.graph
         ), "Destination node does not exist"
         self.add_edge(
-            origin_idx=origin_idx,
-            destination_idx=destination_idx,
+            origin_id=origin_idx,
+            destination_id=destination_idx,
             distance=haversine(
                 self.nodes[origin_idx], self.nodes[destination_idx]
             ),
@@ -1950,7 +2051,7 @@ class GeoGraph(
                     "You can ensure a solution by setting destination_node_addition_type='all' and setting your lat_lon_bound=180.\n"
                     "This will, however, result in a much longer runtime per shortest path query.\n"
                     "If not in an exception block, see the stacktrace below for more details:\n"
-                 ),
+                ),
                 silent=silent,
             )
             raise e

{scgraph-3.2.4 → scgraph-3.4.0}/scgraph/utils.py

@@ -344,6 +344,13 @@ def time_test(name, function, args=None, kwargs=None):
     print(f"{name}: {round((time.time()-start)*1000, 4)}ms")
 
 
+def has_cpp():
+    try:
+        return True
+    except ImportError:
+        return False
+
+
 def cpp_check():
     try:
         print("Using C++ & Python implementation of SCGraph.")

scgraph-3.2.4/build/cp314-cp314-linux_x86_64/CMakeFiles/CheckCXX/CMakeLists.txt

@@ -1,6 +0,0 @@
-cmake_minimum_required(VERSION 4.3.2)
-set(CMAKE_MODULE_PATH "")
-
-project(CheckCXX LANGUAGES CXX)
-file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/result.cmake" "set(CMAKE_CXX_COMPILER \"${CMAKE_CXX_COMPILER}\")
-")