Skip to content

API reference

The reference documents every public module of DispatchAtlas, generated from the docstrings of the installed code. The package is organised in layers, each depending only on packages above it in this list:

Package Holds
dispatchatlas.core the data model, objectives, feasibility checking, seeds, serialization, and the solver contract; no third-party dependency
dispatchatlas.references the bibliography of the implemented methods
dispatchatlas.benchmarks benchmark families, published suites, file readers, catalogs, and instance features
dispatchatlas.solvers the solver registry, the search run-time, the schedule builder, and every solver
dispatchatlas.processes pinned child processes for caller-defined calls, the rows file, process groups and snapshots, detached launch, and watching a run
dispatchatlas.campaigns campaign files, planning, execution, records, the check of a campaign directory, and replay
dispatchatlas.analysis datasets, statistics, tables, figures, and bundles
dispatchatlas.cli the command line, a thin layer over the others

Each package re-exports its main names, so from dispatchatlas.core import Problem and from dispatchatlas.solvers import solve work; the reference documents every name in the module that defines it. The solvers are grouped by kind: heuristics and local search, population and swarm methods, multi-objective methods, learning methods, and exact and hybrid methods. The analysis has separate pages for its statistics and its figures.

Names that start with an underscore are private and may change without notice. Errors the library raises on purpose derive from DispatchAtlasError, and also from the matching built-in exception, such as ValueError for ConfigError and ModelError, and ImportError for MissingDependencyError.