nextroute 1.11.1.dev0__cp39-cp39-win_amd64.whl

nextroute-1.11.1.dev0.dist-info/METADATA

@@ -0,0 +1,281 @@
+Metadata-Version: 2.2
+Name: nextroute
+Version: 1.11.1.dev0
+Summary: Nextroute is an engine for solving Vehicle Routing Problems (VRPs).
+Author-email: Nextmv <tech@nextmv.io>
+Maintainer-email: Nextmv <tech@nextmv.io>
+License: # LICENSE
+        
+        Business Source License 1.1
+        
+        Parameters
+        
+        Licensor:             nextmv.io inc
+        Licensed Work:        nextroute
+        
+        Change Date:          Four years from the date the Licensed Work is published.
+        Change License:       GPLv3
+        
+        For information about alternative licensing arrangements for the Software,
+        please email info@nextmv.io.
+        
+        Notice
+        
+        The Business Source License (this document, or the “License”) is not an Open
+        Source license. However, the Licensed Work will eventually be made available
+        under an Open Source License, as stated in this License.
+        
+        License text copyright © 2023 MariaDB plc, All Rights Reserved. “Business Source
+        License” is a trademark of MariaDB plc.
+        
+        -----------------------------------------------------------------------------
+        
+        ## Terms
+        
+        The Licensor hereby grants you the right to copy, modify, create derivative
+        works, redistribute, and make non-production use of the Licensed Work. The
+        Licensor may make an Additional Use Grant, above, permitting limited production
+        use.
+        
+        Effective on the Change Date, or the fourth anniversary of the first publicly
+        available distribution of a specific version of the Licensed Work under this
+        License, whichever comes first, the Licensor hereby grants you rights under the
+        terms of the Change License, and the rights granted in the paragraph above
+        terminate.
+        
+        If your use of the Licensed Work does not comply with the requirements currently
+        in effect as described in this License, you must purchase a commercial license
+        from the Licensor, its affiliated entities, or authorized resellers, or you must
+        refrain from using the Licensed Work.
+        
+        All copies of the original and modified Licensed Work, and derivative works of
+        the Licensed Work, are subject to this License. This License applies separately
+        for each version of the Licensed Work and the Change Date may vary for each
+        version of the Licensed Work released by Licensor.
+        
+        You must conspicuously display this License on each original or modified copy of
+        the Licensed Work. If you receive the Licensed Work in original or modified form
+        from a third party, the terms and conditions set forth in this License apply to
+        your use of that work.
+        
+        Any use of the Licensed Work in violation of this License will automatically
+        terminate your rights under this License for the current and all other versions
+        of the Licensed Work.
+        
+        This License does not grant you any right in any trademark or logo of Licensor
+        or its affiliates (provided that you may use a trademark or logo of Licensor as
+        expressly required by this License).TO THE EXTENT PERMITTED BY APPLICABLE LAW,
+        THE LICENSED WORK IS PROVIDED ON AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL
+        WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION)
+        WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
+        NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this
+        License’s text to license your works, and to refer to it using the trademark
+        “Business Source License”, as long as you comply with the Covenants of Licensor
+        below.
+        
+        ## Covenants of Licensor
+        
+        In consideration of the right to use this License’s text and the “Business
+        Source License” name and trademark, Licensor covenants to MariaDB, and to all
+        other recipients of the licensed work to be provided by Licensor:
+        
+        To specify as the Change License the GPL Version 2.0 or any later version, or a
+        license that is compatible with GPL Version 2.0 or a later version, where
+        “compatible” means that software provided under the Change License can be
+        included in a program with software provided under GPL Version 2.0 or a later
+        version. Licensor may specify additional Change Licenses without limitation. To
+        either: (a) specify an additional grant of rights to use that does not impose
+        any additional restriction on the right granted in this License, as the
+        Additional Use Grant; or (b) insert the text “None” to specify a Change Date.
+        Not to modify this License in any other way.
+        
+        License text copyright © 2023 MariaDB plc, All Rights Reserved. “Business Source
+        License” is a trademark of MariaDB plc.
+        
+Project-URL: Homepage, https://www.nextmv.io
+Project-URL: Documentation, https://www.nextmv.io/docs/vehicle-routing
+Project-URL: Repository, https://github.com/nextmv-io/nextroute
+Keywords: decision engineering,decision science,decisions,nextmv,optimization,operations research,solver,vehicle routing problem
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.5.2
+
+# Nextroute
+
+Welcome to Nextmv's **Nextroute**, a feature-rich Vehicle Routing Problem (VRP)
+solver written in pure Go. Designed with a focus on maintainability,
+feature-richness, and extensibility, Nextroute is built to handle real-world
+applications across [all platforms that Go (cross)compiles
+to](https://go.dev/doc/install/source#environment).
+
+Our goal is not to compete on specific VRP type benchmarks, but to provide a
+robust and versatile tool that can adapt to a variety of routing use-cases.
+Whether you're optimizing the routes for a small fleet of delivery vans in a
+city or managing complex logistics for a global supply chain, Nextroute is
+equipped to help you find efficient solutions.
+
+You can work with Nextroute in a variety of ways:
+
+* Go package: Import the `nextroute` package in your Go project and use the
+  solver directly.
+* Python package: Use the `nextroute` Python package as an interface to the Go
+  solver.
+
+## Features
+
+| Feature | Description |
+| ------- | ----------- |
+| [Alternate stops](https://www.nextmv.io/docs/vehicle-routing/features/alternate-stops) | Specify a set of alternate stops per vehicle for which only one should be serviced. |
+| [Compatibility attributes](https://www.nextmv.io/docs/vehicle-routing/features/compatibility-attributes) | Specify which stops are compatible with which vehicles. |
+| [Capacity](https://www.nextmv.io/docs/vehicle-routing/features/capacity) | Set capacities for vehicles and quantities (demanded or offered) at stops. |
+| [Cluster constraint](https://www.nextmv.io/docs/vehicle-routing/features/cluster-constraint) | Enforce the creation of clustered routes. |
+| [Cluster objective](https://www.nextmv.io/docs/vehicle-routing/features/cluster-objective) | Incentivize the creation of clustered routes. |
+| [Custom constraints](https://www.nextmv.io/docs/vehicle-routing/features/custom-constraints) | Implement custom constraints with Nextmv SDK. |
+| [Custom data](https://www.nextmv.io/docs/vehicle-routing/features/custom-data) | Add custom data that is preserved in the output. |
+| [Custom matrices](https://www.nextmv.io/docs/vehicle-routing/features/custom-matrices) | Use custom matrices to achieve more precise drive time. |
+| [Custom objectives](https://www.nextmv.io/docs/vehicle-routing/features/custom-objectives) | Implement custom objectives with Nextmv SDK. |
+| [Custom operators](https://www.nextmv.io/docs/vehicle-routing/features/custom-operators) | Implement custom operators with Nextmv SDK. |
+| [Custom output](https://www.nextmv.io/docs/vehicle-routing/features/custom-output) | Create a custom output for your app. |
+| [Distance matrix](https://www.nextmv.io/docs/vehicle-routing/features/distance-matrix) | Specify a distance matrix in the input that provides the distance of going from location A to B. |
+| [Duration matrix](https://www.nextmv.io/docs/vehicle-routing/features/duration-matrix) | Specify a duration matrix in the input that provides the duration of going from location A to B. |
+| [Duration groups](https://www.nextmv.io/docs/vehicle-routing/features/duration-groups) | Specify a duration that is added every time a stop in the group is approached from a stop outside of the group. |
+| [Early arrival time penalty](https://www.nextmv.io/docs/vehicle-routing/features/early-arrival-time-penalty) | Specify a penalty that is added to the objective when arriving before a stop's target arrival time. |
+| [Late arrival time penalty](https://www.nextmv.io/docs/vehicle-routing/features/late-arrival-time-penalty) | Specify a penalty that is added to the objective when arriving after a stop's target arrival time. |
+| [Map data in cloud](https://www.nextmv.io/docs/vehicle-routing/features/map-data) | Calculates duration and distance matrices using a hosted OSRM map service when running on Nextmv Cloud. Note that map data is a paid feature. |
+| [Maximum route distance](https://www.nextmv.io/docs/vehicle-routing/features/max-distance) | Specify the maximum distance that a vehicle can travel. |
+| [Maximum route duration](https://www.nextmv.io/docs/vehicle-routing/features/max-duration) | Specify the maximum duration that a vehicle can travel for. |
+| [Maximum route stops](https://www.nextmv.io/docs/vehicle-routing/features/max-stops) | Specify the maximum stops that a vehicle can visit. |
+| [Maximum wait time](https://www.nextmv.io/docs/vehicle-routing/features/max-wait) | Specify the maximum time a vehicle can wait when arriving before the start time window opens at a stop. |
+| [Minimum route stops](https://www.nextmv.io/docs/vehicle-routing/features/min-stops) | Specify the minimum stops that a vehicle should visit (applying a penalty). |
+| [Nextcheck](https://www.nextmv.io/docs/vehicle-routing/features/nextcheck) | Check which stops can be planned or why stops have been unplanned. |
+| [Precedence](https://www.nextmv.io/docs/vehicle-routing/features/precedence) | Add pickups and deliveries or specify multiple pickups before deliveries and vice versa. |
+| [Stop duration](https://www.nextmv.io/docs/vehicle-routing/features/stop-duration) | Specify the time it takes to service a stop. |
+| [Stop duration multiplier](https://www.nextmv.io/docs/vehicle-routing/features/stop-duration-multiplier) | Specify a multiplier on time it takes a vehicle to service a stop. |
+| [Stop groups](https://www.nextmv.io/docs/vehicle-routing/features/stop-groups) | Specify stops that must be assigned together on the same route, with no further requirements. |
+| [Stop mixing](https://www.nextmv.io/docs/vehicle-routing/features/stop-mixing) | Specify properties of stops which can not be on the vehicle at the same time. |
+| [Time windows](https://www.nextmv.io/docs/vehicle-routing/features/time-windows) | Specify the time window in which a stop must start service. |
+| [Unplanned penalty](https://www.nextmv.io/docs/vehicle-routing/features/unplanned-penalty) | Specify a penalty that is added to the objective to leave a stop unplanned when all constraints cannot be fulfilled. |
+| [Vehicle activation penalty](https://www.nextmv.io/docs/vehicle-routing/features/vehicle-activation-penalty) | Specify a penalty that is added to the objective for activating (using) a vehicle. |
+| [Vehicle initial stops](https://www.nextmv.io/docs/vehicle-routing/features/vehicle-initial-stops) | Specify initial stops planned on a vehicle. |
+| [Vehicle start/end location](https://www.nextmv.io/docs/vehicle-routing/features/vehicle-start-end-location) | Specify optional starting and ending locations for vehicles. |
+| [Vehicle start/end time](https://www.nextmv.io/docs/vehicle-routing/features/vehicle-start-end-time) | Specify optional starting and ending time for a vehicle. |
+
+## License
+
+Please note that Nextroute is provided as _source-available_ software (not
+_open-source_). For further information, please refer to the [LICENSE](./LICENSE.md)
+file.
+
+## Installation
+
+* Go
+
+    Install the Go package with the following command:
+
+    ```bash
+    go get github.com/nextmv-io/nextroute
+    ```
+
+* Python
+
+    Install the Python package with the following command:
+
+    ```bash
+    pip install nextroute
+    ```
+
+## Usage
+
+For further information on how to get started, features, deployment, etc.,
+please refer to the [official
+documentation](https://www.nextmv.io/docs/vehicle-routing/get-started).
+
+### Go
+
+A first run can be done with the following command. Stand at the root of the
+repository and run:
+
+```bash
+go run cmd/main.go -runner.input.path cmd/input.json -solve.duration 5s
+```
+
+This will run the solver for 5 seconds and output the result to the console.
+
+In order to start a _new project_, please refer to the sample app in the
+[community-apps repository](https://github.com/nextmv-io/community-apps/tree/develop/go-nextroute).
+If you have [Nextmv CLI](https://www.nextmv.io/docs/platform/installation#nextmv-cli)
+installed, you can create a new project with the following command:
+
+```bash
+nextmv community clone -a go-nextroute
+```
+
+### Python
+
+A first run can be done by executing the following script. Stand at the root of
+the repository and execute it:
+
+```python
+import json
+
+import nextroute
+
+with open("cmd/input.json") as f:
+    data = json.load(f)
+
+input = nextroute.schema.Input.from_dict(data)
+options = nextroute.Options(SOLVE_DURATION=5)
+output = nextroute.solve(input, options)
+print(json.dumps(output.to_dict(), indent=2))
+```
+
+This will run the solver for 5 seconds and output the result to the console.
+
+In order to start a _new project_, please refer to the sample app in the
+[community-apps repository](https://github.com/nextmv-io/community-apps/tree/develop/python-nextroute).
+If you have [Nextmv CLI](https://www.nextmv.io/docs/platform/installation#nextmv-cli)
+installed, you can create a new project with the following command:
+
+```bash
+nextmv community clone -a python-nextroute
+```
+
+## Local benchmarking
+
+To run the go benchmarks locally, you can use the following command:
+
+```bash
+go test -benchmem -timeout 20m -run=^$ -count 10 -bench "^Benchmark" ./...
+```
+
+In order to compare changes from a PR with the latest `develop` version, you can
+use `benchstat`.
+
+```bash
+# on the develop branch (or any other branch)
+go test -benchmem -timeout 20m -run=^$ -count 10 -bench "^Benchmark" ./...\
+ | tee develop.txt
+# on the new branch (or any other branch)
+go test -benchmem -timeout 20m -run=^$ -count 10 -bench "^Benchmark" ./...\
+ | tee new.txt
+# compare the two
+benchstat develop.txt new.txt
+```
+
+## Versioning
+
+We try our best to version our software thoughtfully and only break APIs and
+behaviors when we have a good reason to.
+
+* Minor (`v1.^.0`) tags: new features, might be breaking.
+* Patch (`v1.0.^`) tags: bug fixes.

nextroute-1.11.1.dev0.dist-info/RECORD

@@ -0,0 +1,26 @@
+nextroute/__about__.py,sha256=-2DH_lsrTALT7QP4yB_ct2IyWF-R_bIKY3UcHuC82zs,65
+nextroute/__init__.py,sha256=Ai-wDfMB-Yd8WsI42vjuQKlNOA7bYZpqTIArtXWfdPY,547
+nextroute/base_model.py,sha256=dKv6OdyXcZm83NhDAS1eTKMDUyKJVUP6EKX8cDJDe_M,565
+nextroute/options.py,sha256=Mlb_4oCj0yQcQRI9s3FRkQR5GP5TLIrU9uL65va3ZL8,8450
+nextroute/solve.py,sha256=UWBKh1884aper0dAK--cDsbfNuuc8TJGE4tfhom9844,4337
+nextroute/version.py,sha256=2vL_WuVQA76en7WJTbof4cJbHOTljpCA5nL7DGbgFvU,337
+nextroute/bin/nextroute.exe,sha256=V1Df83JT93uz9b6F6caQhqNOdlosW4FjUV6GmZUbnto,14251008
+nextroute/check/__init__.py,sha256=KCNtywi2e8jQeDyfEkg_Vo4Mu11lYC2CxwntC1JEZjY,1331
+nextroute/check/schema.py,sha256=ue5Xb4gohz_DQSHWZ61i-IK6DRMppsVYKmilcsxcs9Q,5998
+nextroute/schema/__init__.py,sha256=AHzMPxEel3udVhKzVRwV3642qLarZohfc31xhovofDw,1196
+nextroute/schema/input.py,sha256=uUkDlwkPuIN_w_ScRFhNT0yxSzuxoWvdTgQR9RSzKYI,2943
+nextroute/schema/location.py,sha256=n1ZQAc_FQo2-fL1JwKKQmgCSEFP0wkTE_w3_6QEmxOE,317
+nextroute/schema/output.py,sha256=46nvLAw3QXSgYUCVE13_fGn5wHXpDpGZGuf7YxsLmmk,4950
+nextroute/schema/statistics.py,sha256=ICbCa7V0X2bHGEj_yDMq6NV9euG1qOYOYNH-ZosEzto,3749
+nextroute/schema/stop.py,sha256=LU4-i4cWaZVg_86bgVBRbX2CRPrW715BRy_I7eKw3cI,2264
+nextroute/schema/vehicle.py,sha256=K_mAgM6p6Ef0HXcDC2g7AbvNPxxhnSbjduGsVV4Eazg,2607
+tests/schema/__init__.py,sha256=UrdqXQHUHkSG7vHemeoeJtUm2_afa6-KFo0Fs2l9zG8,33
+tests/schema/test_input.py,sha256=qYdr9d5WDoBFcTK1JKtY12akB_Z3L7HpxOD2dsCH38U,1910
+tests/schema/test_output.py,sha256=L_zeFroI_0wpwsxvhfL69N-kmcYB2Gu9IktAmq4vQIY,11897
+tests/solve_golden/__init__.py,sha256=UrdqXQHUHkSG7vHemeoeJtUm2_afa6-KFo0Fs2l9zG8,33
+tests/solve_golden/main.py,sha256=Hh7IsGKnWOH3IQsI__H5diKNy-4rQ5PS7X40E_xG0B0,1788
+nextroute-1.11.1.dev0.dist-info/LICENSE,sha256=4jrNU-0mMZDGEdwQi9vJ7w-Ep59Kqc7XcOLhDkQbCnM,4194
+nextroute-1.11.1.dev0.dist-info/METADATA,sha256=0A62648LHbygHtYgQ_OZ4KPcXT_hKu_xPg1r4bmi9og,15876
+nextroute-1.11.1.dev0.dist-info/WHEEL,sha256=agy-BJge3afXwWznUXANATmKFW4eqelqRR0uf608A_0,99
+nextroute-1.11.1.dev0.dist-info/top_level.txt,sha256=KNsuo1j7tr-QvBFS_ELmo68OmJ-orEZiOXqstGLJDXA,16
+nextroute-1.11.1.dev0.dist-info/RECORD,,

nextroute-1.11.1.dev0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: false
+Tag: cp39-cp39-win_amd64
+

nextroute-1.11.1.dev0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+nextroute
+tests

tests/schema/__init__.py

@@ -0,0 +1 @@
+# © 2019-present nextmv.io inc

tests/schema/test_input.py

@@ -0,0 +1,59 @@
+# © 2019-present nextmv.io inc
+
+import json
+import os
+import unittest
+
+from nextroute.schema import Input, Stop, Vehicle
+
+
+class TestInput(unittest.TestCase):
+    filepath = os.path.join(os.path.dirname(__file__), "input.json")
+
+    def test_from_json(self):
+        with open(self.filepath) as f:
+            json_data = json.load(f)
+
+        nextroute_input = Input.from_dict(json_data)
+        parsed = nextroute_input.to_dict()
+
+        for s, stop in enumerate(parsed["stops"]):
+            original_stop = json_data["stops"][s]
+            self.assertEqual(
+                stop,
+                original_stop,
+                f"stop: parsed({stop}) and original ({original_stop}) should be equal",
+            )
+
+        for v, vehicle in enumerate(parsed["vehicles"]):
+            original_vehicle = json_data["vehicles"][v]
+            self.assertEqual(
+                vehicle,
+                original_vehicle,
+                f"vehicle: parsed ({vehicle}) and original ({original_vehicle}) should be equal",
+            )
+
+        self.assertEqual(
+            parsed["defaults"],
+            json_data["defaults"],
+            f"defaults: parsed ({parsed['defaults']}) and original ({json_data['defaults']}) should be equal",
+        )
+
+    def test_from_dict(self):
+        with open(self.filepath) as f:
+            json_data = json.load(f)
+
+        nextroute_input = Input.from_dict(json_data)
+        stops = nextroute_input.stops
+        for stop in stops:
+            self.assertTrue(
+                isinstance(stop, Stop),
+                f"Stop ({stop}) should be of type Stop.",
+            )
+
+        vehicles = nextroute_input.vehicles
+        for vehicle in vehicles:
+            self.assertTrue(
+                isinstance(vehicle, Vehicle),
+                f"Vehicle ({vehicle}) should be of type Vehicle.",
+            )