nextmv 0.10.3.dev0__py3-none-any.whl → 0.35.0__py3-none-any.whl

nextmv/cloud/status.py

@@ -1,29 +0,0 @@
-from enum import Enum
-
-
-class Status(str, Enum):
-    """Status of a run. Deprecated: use StatusV2."""
-
-    failed = "failed"
-    """Run failed."""
-    running = "running"
-    """Run is running."""
-    succeeded = "succeeded"
-    """Run succeeded."""
-
-
-class StatusV2(str, Enum):
-    """Status of a run."""
-
-    canceled = "canceled"
-    """Run was canceled."""
-    failed = "failed"
-    """Run failed."""
-    none = "none"
-    """Run has no status."""
-    queued = "queued"
-    """Run is queued."""
-    running = "running"
-    """Run is running."""
-    succeeded = "succeeded"
-    """Run succeeded."""

nextmv/nextroute/__init__.py

@@ -1,2 +0,0 @@
-"""Nextroute is a fast and flexible solver for Vehicle Routing Problems
-(VRPs)."""

nextmv/nextroute/check/__init__.py

@@ -1,26 +0,0 @@
-"""
-Check provides a plugin that allows you to check models and solutions.
-
-Checking a model or a solution checks the unplanned plan units. It checks each
-individual plan unit if it can be added to the solution. If the plan unit can
-be added to the solution, the report will include on how many vehicles and
-what the impact would be on the objective value. If the plan unit cannot be
-added to the solution, the report will include the reason why it cannot be
-added to the solution.
-
-The check can be invoked on a nextroute.Model or a nextroute.Solution. If the
-check is invoked on a model, an empty solution is created and the check is
-executed on this empty solution. An empty solution is a solution with all the
-initial stops that are fixed, initial stops that are not fixed are not added
-to the solution. The check is executed on the unplanned plan units of the
-solution. If the check is invoked on a solution, it is executed on the
-unplanned plan units of the solution.
-"""
-
-from .schema import Objective as Objective
-from .schema import ObjectiveTerm as ObjectiveTerm
-from .schema import Output as Output
-from .schema import PlanUnit as PlanUnit
-from .schema import Solution as Solution
-from .schema import Summary as Summary
-from .schema import Vehicle as Vehicle

nextmv/nextroute/check/schema.py

@@ -1,141 +0,0 @@
-"""This module contains definitions for the schema in the Nextroute check."""
-
-from typing import Dict, List, Optional
-
-from nextmv.base_model import BaseModel
-
-
-class ObjectiveTerm(BaseModel):
-    """Check of the individual terms of the objective for a move."""
-
-    base: Optional[float] = None
-    """Base of the objective term."""
-    factor: Optional[float] = None
-    """Factor of the objective term."""
-    name: Optional[str] = None
-    """Name of the objective term."""
-    value: Optional[float] = None
-    """Value of the objective term, which is equivalent to `self.base *
-    self.factor`."""
-
-
-class Objective(BaseModel):
-    """Estimate of an objective of a move."""
-
-    terms: Optional[List[ObjectiveTerm]] = None
-    """Check of the individual terms of the objective."""
-    value: Optional[float] = None
-    """Value of the objective."""
-    vehicle: Optional[str] = None
-    """ID of the vehicle for which it reports the objective."""
-
-
-class Solution(BaseModel):
-    """Solution that the check has been executed on."""
-
-    objective: Optional[Objective] = None
-    """Objective of the start solution."""
-    plan_units_planned: Optional[int] = None
-    """Number of plan units planned in the start solution."""
-    plan_units_unplanned: Optional[int] = None
-    """Number of plan units unplanned in the start solution."""
-    stops_planned: Optional[int] = None
-    """Number of stops planned in the start solution."""
-    vehicles_not_used: Optional[int] = None
-    """Number of vehicles not used in the start solution."""
-    vehicles_used: Optional[int] = None
-    """Number of vehicles used in the start solution."""
-
-
-class Summary(BaseModel):
-    """Summary of the check."""
-
-    moves_failed: Optional[int] = None
-    """number of moves that failed. A move can fail if the estimate of a
-    constraint is incorrect. A constraint is incorrect if `ModelConstraint.
-    EstimateIsViolated` returns true and one of the violation checks returns
-    false. Violation checks are implementations of one or more of the
-    interfaces [SolutionStopViolationCheck], [SolutionVehicleViolationCheck] or
-    [SolutionViolationCheck] on the same constraint. Most constraints do not
-    need and do not have violation checks as the estimate is perfect. The
-    number of moves failed can be more than one per plan unit as we continue to
-    try moves on different vehicles until we find a move that is executable or
-    all vehicles have been visited."""
-    plan_units_best_move_failed: Optional[int] = None
-    """Number of plan units for which the best move can not be planned. This
-    should not happen if all the constraints are implemented correct."""
-    plan_units_best_move_found: Optional[int] = None
-    """Number of plan units for which at least one move has been found and the
-    move is executable."""
-    plan_units_best_move_increases_objective: Optional[int] = None
-    """Number of plan units for which the best move is executable but would
-    increase the objective value instead of decreasing it."""
-    plan_units_checked: Optional[int] = None
-    """Number of plan units that have been checked. If this is less than
-    `self.plan_units_to_be_checked` the check timed out."""
-    plan_units_have_no_move: Optional[int] = None
-    """Number of plan units for which no feasible move has been found. This
-    implies there is no move that can be executed without violating a
-    constraint."""
-    plan_units_to_be_checked: Optional[int] = None
-    """Number of plan units to be checked."""
-
-
-class PlanUnit(BaseModel):
-    """Check of a plan unit."""
-
-    best_move_failed: Optional[bool] = None
-    """True if the plan unit's best move failed to execute."""
-    best_move_increases_objective: Optional[bool] = None
-    """True if the best move for the plan unit increases the objective."""
-    best_move_objective: Optional[Objective] = None
-    """Estimate of the objective of the best move if the plan unit has a best
-    move."""
-    constraints: Optional[Dict[str, int]] = None
-    """Constraints that are violated for the plan unit."""
-    has_best_move: Optional[bool] = None
-    """True if a move is found for the plan unit. A plan unit has no move found
-    if the plan unit is over-constrained or the move found is too expensive."""
-    stops: Optional[List[str]] = None
-    """IDs of the sops in the plan unit."""
-    vehicles_have_moves: Optional[int] = None
-    """Number of vehicles that have moves for the plan unit. Only calculated if
-    the verbosity is very high."""
-    vehicles_with_moves: Optional[List[str]] = None
-    """IDs of the vehicles that have moves for the plan unit. Only calculated
-    if the verbosity is very high."""
-
-
-class Vehicle(BaseModel):
-    """Check of a vehicle."""
-
-    id: str
-    """ID of the vehicle."""
-
-    plan_units_have_moves: Optional[int] = None
-    """Number of plan units that have moves for the vehicle. Only calculated if
-    the depth is medium."""
-
-
-class Output(BaseModel):
-    """Output of a feasibility check."""
-
-    duration_maximum: Optional[float] = None
-    """Maximum duration of the check, in seconds."""
-    duration_used: Optional[float] = None
-    """Duration used by the check, in seconds."""
-    error: Optional[str] = None
-    """Error raised during the check."""
-    plan_units: Optional[List[PlanUnit]] = None
-    """Check of the individual plan units."""
-    remark: Optional[str] = None
-    """Remark of the check. It can be "ok", "timeout" or anything else that
-    should explain itself."""
-    solution: Optional[Solution] = None
-    """Start soltuion of the check."""
-    summary: Optional[Summary] = None
-    """Summary of the check."""
-    vehicles: Optional[List[Vehicle]] = None
-    """Check of the vehicles."""
-    verbosity: Optional[str] = None
-    """Verbosity level of the check."""

nextmv/nextroute/schema/__init__.py

@@ -1,19 +0,0 @@
-"""Schema (class) definitions for the entities in Nextroute."""
-
-from .input import Defaults as Defaults
-from .input import DurationGroup as DurationGroup
-from .input import Input as Input
-from .location import Location as Location
-from .output import ObjectiveOutput as ObjectiveOutput
-from .output import Output as Output
-from .output import PlannedStopOutput as PlannedStopOutput
-from .output import Solution as Solution
-from .output import StopOutput as StopOutput
-from .output import VehicleOutput as VehicleOutput
-from .output import Version as Version
-from .stop import AlternateStop as AlternateStop
-from .stop import Stop as Stop
-from .stop import StopDefaults as StopDefaults
-from .vehicle import InitialStop as InitialStop
-from .vehicle import Vehicle as Vehicle
-from .vehicle import VehicleDefaults as VehicleDefaults

nextmv/nextroute/schema/input.py

@@ -1,52 +0,0 @@
-"""Defines the input class."""
-
-from typing import Any, List, Optional
-
-from nextmv.base_model import BaseModel
-from nextmv.nextroute.schema.stop import AlternateStop, Stop, StopDefaults
-from nextmv.nextroute.schema.vehicle import Vehicle, VehicleDefaults
-
-
-class Defaults(BaseModel):
-    """Default values for vehicles and stops."""
-
-    stops: Optional[StopDefaults] = None
-    """Default values for stops."""
-    vehicles: Optional[VehicleDefaults] = None
-    """Default values for vehicles."""
-
-
-class DurationGroup(BaseModel):
-    """Represents a group of stops that get additional duration whenever a stop
-    of the group is approached for the first time."""
-
-    duration: int
-    """Duration to add when visiting the group."""
-    group: List[str]
-    """Stop IDs contained in the group."""
-
-
-class Input(BaseModel):
-    """Input schema for Nextroute."""
-
-    stops: List[Stop]
-    """Stops that must be visited by the vehicles."""
-    vehicles: List[Vehicle]
-    """Vehicles that service the stops."""
-
-    alternate_stops: Optional[List[AlternateStop]] = None
-    """A set of alternate stops for the vehicles."""
-    custom_data: Optional[Any] = None
-    """Arbitrary data associated with the input."""
-    defaults: Optional[Defaults] = None
-    """Default values for vehicles and stops."""
-    distance_matrix: Optional[List[List[float]]] = None
-    """Matrix of travel distances in meters between stops."""
-    duratrion_groups: Optional[List[DurationGroup]] = None
-    """Duration in seconds added when approaching the group."""
-    duration_matrix: Optional[List[List[float]]] = None
-    """Matrix of travel durations in seconds between stops."""
-    options: Optional[Any] = None
-    """Arbitrary options."""
-    stop_groups: Optional[List[List[str]]] = None
-    """Groups of stops that must be part of the same route."""

nextmv/nextroute/schema/location.py

@@ -1,13 +0,0 @@
-"""Defines the location class."""
-
-
-from nextmv.base_model import BaseModel
-
-
-class Location(BaseModel):
-    """Location represents a geographical location."""
-
-    lat: float
-    """Latitude of the location."""
-    lon: float
-    """Longitude of the location."""

nextmv/nextroute/schema/output.py

@@ -1,136 +0,0 @@
-"""Defines the output class."""
-
-from datetime import datetime
-from typing import Any, Dict, List, Optional
-
-from nextmv.base_model import BaseModel
-from nextmv.nextroute.check import Output as checkOutput
-from nextmv.nextroute.schema.location import Location
-from nextmv.output import Statistics
-
-
-class Version(BaseModel):
-    """A version used for solving."""
-
-    sdk: str
-    """Nextmv SDK."""
-
-
-class StopOutput(BaseModel):
-    """Basic structure for the output of a stop."""
-
-    id: str
-    """ID of the stop."""
-    location: Location
-    """Location of the stop."""
-
-    custom_data: Optional[Any] = None
-    """Custom data of the stop."""
-
-
-class PlannedStopOutput(BaseModel):
-    """Output of a stop planned in the solution."""
-
-    stop: StopOutput
-    """Basic information on the stop."""
-
-    arrival_time: Optional[datetime] = None
-    """Actual arrival time at this stop."""
-    cumulative_travel_distance: Optional[float] = None
-    """Cumulative distance to travel from the first stop to this one, in meters."""
-    cumulative_travel_duration: Optional[float] = None
-    """Cumulative duration to travel from the first stop to this one, in seconds."""
-    custom_data: Optional[Any] = None
-    """Custom data of the stop."""
-    duration: Optional[float] = None
-    """Duration of the service at the stop, in seconds."""
-    early_arrival_duration: Optional[float] = None
-    """Duration of early arrival at the stop, in seconds."""
-    end_time: Optional[datetime] = None
-    """End time of the service at the stop."""
-    late_arrival_duration: Optional[float] = None
-    """Duration of late arrival at the stop, in seconds."""
-    mix_items: Optional[Any] = None
-    """Mix items at the stop."""
-    start_time: Optional[datetime] = None
-    """Start time of the service at the stop."""
-    target_arrival_time: Optional[datetime] = None
-    """Target arrival time at this stop."""
-    travel_distance: Optional[float] = None
-    """Distance to travel from the previous stop to this one, in meters."""
-    travel_duration: Optional[float] = None
-    """Duration to travel from the previous stop to this one, in seconds."""
-    waiting_duration: Optional[float] = None
-    """Waiting duratino at the stop, in seconds."""
-
-
-class VehicleOutput(BaseModel):
-    """Output of a vehicle in the solution."""
-
-    id: str
-    """ID of the vehicle."""
-
-    alternate_stops: Optional[List[str]] = None
-    """List of alternate stops that were planned on the vehicle."""
-    custom_data: Optional[Any] = None
-    """Custom data of the vehicle."""
-    route: Optional[List[PlannedStopOutput]] = None
-    """Route of the vehicle, which is a list of stops that were planned on
-    it."""
-    route_duration: Optional[float] = None
-    """Total duration of the vehicle's route, in seconds."""
-    route_stops_duration: Optional[float] = None
-    """Total duration of the stops of the vehicle, in seconds."""
-    route_travel_distance: Optional[float] = None
-    """Total travel distance of the vehicle, in meters."""
-    route_travel_duration: Optional[float] = None
-    """Total travel duration of the vehicle, in seconds."""
-    route_waiting_duration: Optional[float] = None
-    """Total waiting duration of the vehicle, in seconds."""
-
-
-class ObjectiveOutput(BaseModel):
-    """Information of the objective (value function)."""
-
-    name: str
-    """Name of the objective."""
-
-    base: Optional[float] = None
-    """Base of the objective."""
-    custom_data: Optional[Any] = None
-    """Custom data of the objective."""
-    factor: Optional[float] = None
-    """Factor of the objective."""
-    objectives: Optional[List[Dict[str, Any]]] = None
-    """List of objectives. Each list is actually of the same class
-    `ObjectiveOutput`, but we avoid a recursive definition here."""
-    value: Optional[float] = None
-    """Value of the objective, which is equivalent to `self.base *
-    self.factor`."""
-
-
-class Solution(BaseModel):
-    """Solution to a Vehicle Routing Problem (VRP)."""
-
-    unplanned: Optional[List[StopOutput]] = None
-    """List of stops that were not planned in the solution."""
-    vehicles: Optional[List[VehicleOutput]] = None
-    """List of vehicles in the solution."""
-    objective: Optional[ObjectiveOutput] = None
-    """Information of the objective (value function)."""
-    check: Optional[checkOutput] = None
-    """Check of the solution, if enabled."""
-
-
-class Output(BaseModel):
-    """Output schema for Nextroute."""
-
-    options: Dict[str, Any]
-    """Options used to obtain this output."""
-    version: Version
-    """Versions used for the solution."""
-
-    solutions: Optional[List[Solution]] = None
-    """Solutions to the problem."""
-    statistics: Optional[Statistics] = None
-    """Statistics of the solution."""

nextmv/nextroute/schema/stop.py

@@ -1,61 +0,0 @@
-"""Defines the stop class."""
-
-from datetime import datetime
-from typing import Any, List, Optional
-
-from nextmv.base_model import BaseModel
-from nextmv.nextroute.schema.location import Location
-
-
-class StopDefaults(BaseModel):
-    """Default values for a stop."""
-
-    compatibility_attributes: Optional[List[str]] = None
-    """Attributes that the stop is compatible with."""
-    duration: Optional[int] = None
-    """Duration of the stop in seconds."""
-    early_arrival_time_penalty: Optional[float] = None
-    """Penalty per second for arriving at the stop before the target arrival time."""
-    late_arrival_time_penalty: Optional[float] = None
-    """Penalty per second for arriving at the stop after the target arrival time."""
-    max_wait: Optional[int] = None
-    """Maximum waiting duration in seconds at the stop."""
-    quantity: Optional[Any] = None
-    """Quantity of the stop."""
-    start_time_window: Optional[Any] = None
-    """Time window in which the stop can start service."""
-    target_arrival_time: Optional[datetime] = None
-    """Target arrival time at the stop."""
-    unplanned_penalty: Optional[int] = None
-    """Penalty for not planning a stop."""
-
-
-class Stop(StopDefaults):
-    """Stop is a location that must be visited by a vehicle in a Vehicle
-    Routing Problem (VRP.)"""
-
-    id: str
-    """Unique identifier for the stop."""
-    location: Location
-    """Location of the stop."""
-
-    custom_data: Optional[Any] = None
-    """Arbitrary data associated with the stop."""
-    mixing_items: Optional[Any] = None
-    """Defines the items that are inserted or removed from the vehicle when visiting the stop."""
-    precedes: Optional[Any] = None
-    """Stops that must be visited after this one on the same route."""
-    succeeds: Optional[Any] = None
-    """Stops that must be visited before this one on the same route."""
-
-
-class AlternateStop(StopDefaults):
-    """An alternate stop can be serviced instead of another stop."""
-
-    id: str
-    """Unique identifier for the stop."""
-    location: Location
-    """Location of the stop."""
-
-    custom_data: Optional[Any] = None
-    """Arbitrary data associated with the stop."""

nextmv/nextroute/schema/vehicle.py

@@ -1,68 +0,0 @@
-"""Defines the vehicle class."""
-
-from datetime import datetime
-from typing import Any, List, Optional
-
-from nextmv.base_model import BaseModel
-from nextmv.nextroute.schema.location import Location
-
-
-class InitialStop(BaseModel):
-    """Represents a stop that is already planned on a vehicle."""
-
-    id: str
-    """Unique identifier of the stop."""
-
-    fixed: Optional[bool] = None
-    """Whether the stop is fixed on the route."""
-
-
-class VehicleDefaults(BaseModel):
-    """Default values for vehicles."""
-
-    activation_penalty: Optional[int] = None
-    """Penalty of using the vehicle."""
-    alternate_stops: Optional[List[str]] = None
-    """A set of alternate stops for which only one should be serviced."""
-    capacity: Optional[Any] = None
-    """Capacity of the vehicle."""
-    compatibility_attributes: Optional[List[str]] = None
-    """Attributes that the vehicle is compatible with."""
-    end_location: Optional[Location] = None
-    """Location where the vehicle ends."""
-    end_time: Optional[datetime] = None
-    """Latest time at which the vehicle ends its route."""
-    max_distance: Optional[int] = None
-    """Maximum distance in meters that the vehicle can travel."""
-    max_duration: Optional[int] = None
-    """Maximum duration in seconds that the vehicle can travel."""
-    max_stops: Optional[int] = None
-    """Maximum number of stops that the vehicle can visit."""
-    max_wait: Optional[int] = None
-    """Maximum aggregated waiting time that the vehicle can wait across route stops."""
-    min_stops: Optional[int] = None
-    """Minimum stops that a vehicle should visit."""
-    min_stops_penalty: Optional[float] = None
-    """Penalty for not visiting the minimum number of stops."""
-    speed: Optional[float] = None
-    """Speed of the vehicle in meters per second."""
-    start_level: Optional[Any] = None
-    """Initial level of the vehicle."""
-    start_location: Optional[Location] = None
-    """Location where the vehicle starts."""
-    start_time: Optional[datetime] = None
-    """Time when the vehicle starts its route."""
-
-
-class Vehicle(VehicleDefaults):
-    """A vehicle services stops in a Vehicle Routing Problem (VRP)."""
-
-    id: str
-    """Unique identifier of the vehicle."""
-
-    custom_data: Optional[Any] = None
-    """Arbitrary custom data."""
-    initial_stops: Optional[List[InitialStop]] = None
-    """Initial stops planned on the vehicle."""
-    stop_duration_multiplier: Optional[float] = None
-    """Multiplier for the duration of stops."""

nextmv-0.10.3.dev0.dist-info/RECORD

@@ -1,28 +0,0 @@
-nextmv/__about__.py,sha256=FcvYDh9TY1RQoYtd35-lgBzGMYH_osufNgX9Nw2w-lc,29
-nextmv/__init__.py,sha256=Yaxwb8eKEs8qsDRCqPBW60hgVx99MIt0HNN3NjMGSmM,1092
-nextmv/base_model.py,sha256=-8V8HO3h0InD8vcEo_O9rJL1RKUXacQ36V3tngy3TUM,506
-nextmv/input.py,sha256=t-9e1L3-9Z8S4xVWBkFD_qiSHVGEpi9NsBlXeZ0dXOE,11228
-nextmv/logger.py,sha256=5qQ7E3Aaw3zzkIeiUuwYGzTcB7VhVqIzNZm5PHmdpUI,852
-nextmv/options.py,sha256=QRDLAh8MHnvGghKRN3BjhdVTIq5zM0u5WxkTIvpVBbI,7730
-nextmv/output.py,sha256=KFdG4vLR81AKdzGiXaM4z4XlmCVNEBN0IzjYoxg3FNM,15375
-nextmv/cloud/__init__.py,sha256=3X7tGGCUtcrZUkHqFomkPqtxcQfXOQDSCuPDhvflfUM,1451
-nextmv/cloud/acceptance_test.py,sha256=RU7bgUM4l8XpNqbTvTXwA4_u0c51aPlfDRoqJ0Tio1w,2567
-nextmv/cloud/account.py,sha256=0ZB71lM9vZzBiqaHd5Lpm6XWXEvZjN7eswg3VIUm_uc,1865
-nextmv/cloud/application.py,sha256=WZM36F-1UvyMkyzHjjtzHjEzPJW5rZKxpldqS6juYxI,27663
-nextmv/cloud/batch_experiment.py,sha256=-SPh9XMp53Vb61t6tHI1hfCL8gLH3N2r7QzMBZPZ7fo,2248
-nextmv/cloud/client.py,sha256=QFu8Bg9DKWYfIau0vklSXqsYwjXTpbaKQ-ERmZiToMs,7088
-nextmv/cloud/input_set.py,sha256=qw_ndwbwkkzjVgP2uvNpyL8DhWcXKDh3RqPB-DB_Ilc,696
-nextmv/cloud/status.py,sha256=C-ax8cLw0jPeh7CPsJkCa0s4ImRyFI4NDJJxI0_1sr4,602
-nextmv/nextroute/__init__.py,sha256=HNyvOhT7ZCB5evpRcoiYK4k8IC10nTW6wItWd5SUg-4,83
-nextmv/nextroute/check/__init__.py,sha256=iUEZc6pImAygAfFx7ary7HKKksLF0oPnMkaoGok9llw,1270
-nextmv/nextroute/check/schema.py,sha256=cc-bHsyPxIXtaLIhPxuiO0uXk3Ce8RkA-DHJHmVw8Jo,5815
-nextmv/nextroute/schema/__init__.py,sha256=uMJFUW6ny9rVH1hwO0nbvlL_B8CS68BasFxdrhJZzBg,830
-nextmv/nextroute/schema/input.py,sha256=vjf9tP1UQ87XY8_HcauoLd8fVLOsOYbiQCFTbk58428,1839
-nextmv/nextroute/schema/location.py,sha256=P1zqIXnMOP7doQ57_AKQhUhUB5bdB3BAmUTkGXZc1_o,264
-nextmv/nextroute/schema/output.py,sha256=3JwgNWszF7jQcnji2DtemK0By5gullR_bqH8r-zs1l4,4765
-nextmv/nextroute/schema/stop.py,sha256=ilYf-3rdEVDlwyTiqb1y6ipd9QpLvFPuErPZI6bTHPM,2168
-nextmv/nextroute/schema/vehicle.py,sha256=m9PYupXiVdRF_CgyMiyql7vwNhac-BWyosExISGBXSQ,2504
-nextmv-0.10.3.dev0.dist-info/METADATA,sha256=xg1pqezT2ljyqhHh9aGc5M7y-WderQvEICbWavo1y5o,21722
-nextmv-0.10.3.dev0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-nextmv-0.10.3.dev0.dist-info/licenses/LICENSE,sha256=ZIbK-sSWA-OZprjNbmJAglYRtl5_K4l9UwAV3PGJAPc,11349
-nextmv-0.10.3.dev0.dist-info/RECORD,,