Skip to content

mamut_routing_tools.family.naming

Naming and on-disk layout of a MAMUT benchmark collection (v2, Stream 12').

One base instance = one customer set = one name across every problem type: poryos-<city>-n<N>-<method> (method in {poi, hyb}). TD subinstances append -<model>-<intensity> (6 per base). Extra static-only VRPTW TW sets append -tw-<set> (the tw- prefix cannot collide with the TD tags); the TD-paired VRPTW instance keeps the bare base name, mirroring the TDVRPTW twins that embed the same windows. The family lives in a single family-first collection repo mounted at benchmarks/Poryos2026/:

sidecars/<city>/n=<N>/<base>/            shared sidecars of the base
CVRP/<metric>/<city>/n=<N>/<base>/
VRPTW/fastest/<city>/n=<N>/<base>/       one file per TW set
TDVRP/<city>/n=<N>/<base>/<sub>/
TDVRPTW/<city>/n=<N>/<base>/<sub>/

family_prefix 

family_prefix(family: str = FAMILY) -> str

A family's base-name prefix: its name minus the trailing release year.

Poryos2026 -> poryos, Mamut2026 -> mamut. A rule rather than a lookup table, so adding a family means picking a name and nothing else.

Source code in MAMUT-routing-tools/src/mamut_routing_tools/family/naming.py 
38
39
40
41
42
43
44
45
46
47
def family_prefix(family: str = FAMILY) -> str:
    """A family's base-name prefix: its name minus the trailing release year.

    ``Poryos2026 -> poryos``, ``Mamut2026 -> mamut``. A rule rather than a
    lookup table, so adding a family means picking a name and nothing else.
    """
    stem = _RELEASE_YEAR_SUFFIX.sub("", family)
    if not stem:
        raise ValueError(f"family {family!r} has no name part before its release year")
    return stem.lower()

base_instance_name 

base_instance_name(
    city: str,
    n: int,
    method_tag: str,
    family: str = FAMILY,
    *,
    route_count: int | None = None,
) -> str

<family>-<city>-n<N>[-k<K>]-<method>.

route_count is the bin-packing minimum fleet. It is only written into the name for families in :data:FAMILIES_WITH_FLEET_IN_NAME, and passing it for a family that does not want it is a caller error rather than a silent no-op: a name that sometimes carries k and sometimes does not is unparseable.

Source code in MAMUT-routing-tools/src/mamut_routing_tools/family/naming.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def base_instance_name(
    city: str,
    n: int,
    method_tag: str,
    family: str = FAMILY,
    *,
    route_count: int | None = None,
) -> str:
    """``<family>-<city>-n<N>[-k<K>]-<method>``.

    ``route_count`` is the bin-packing minimum fleet. It is only written into the
    name for families in :data:`FAMILIES_WITH_FLEET_IN_NAME`, and passing it for
    a family that does not want it is a caller error rather than a silent no-op:
    a name that sometimes carries ``k`` and sometimes does not is unparseable.
    """
    prefix = f"{family_prefix(family)}-{city}-n{n}"
    if family in FAMILIES_WITH_FLEET_IN_NAME:
        if route_count is None:
            raise ValueError(
                f"{family} base names carry the fleet lower bound; pass route_count"
            )
        prefix = f"{prefix}-k{int(route_count)}"
    elif route_count is not None:
        raise ValueError(
            f"{family} base names do not carry a fleet lower bound; drop route_count"
        )
    return f"{prefix}-{method_tag}".lower()

vrptw_instance_name 

vrptw_instance_name(base: str, tw_set: str) -> str

TD-paired set: the bare base name; static-only sets: <base>-tw-<set>.

Source code in MAMUT-routing-tools/src/mamut_routing_tools/family/naming.py 
 97
 98
 99
100
101
102
103
def vrptw_instance_name(base: str, tw_set: str) -> str:
    """TD-paired set: the bare base name; static-only sets: ``<base>-tw-<set>``."""
    if tw_set == TW_SET_TD_SHARED:
        return base
    if tw_set not in EXTRA_TW_SETS:
        raise ValueError(f"unknown TW set {tw_set!r} (expected one of {ALL_TW_SETS})")
    return f"{base}-tw-{tw_set}"

sidecar_relpath 

sidecar_relpath(
    city: str, n: int, base: str, filename: str
) -> str

Collection-root-relative sidecar path (the form stored in instance refs).

Source code in MAMUT-routing-tools/src/mamut_routing_tools/family/naming.py 
115
116
117
def sidecar_relpath(city: str, n: int, base: str, filename: str) -> str:
    """Collection-root-relative sidecar path (the form stored in instance refs)."""
    return f"sidecars/{_city_dir(city)}/n={n}/{base}/{filename}"