Skip to main content

Fast, Monte Carlo DAG propagation simulator with user‑defined delay distributions

Project description

mc_dagprop

PyPI version
Python Versions
License

mc_dagprop is a fast, Monte Carlo–style propagation simulator for directed acyclic graphs (DAGs),
written in C++ with Python bindings via pybind11. It allows you to model timing networks
(timetables, precedence graphs, etc.) and inject user-defined delay distributions on edges.

Under the hood, we leverage the high-performance utl::random module
for all pseudo-random number generation—offering better speed and quality than the standard library.


Features

  • Lightweight & high-performance core in C++
  • Simple Python API via poetry or pip
  • Custom per-activity-type delay distributions:
    • Constant (linear scaling)
    • Exponential (scales base duration with cutoff)
    • Gamma (shape & scale, to scale base duration)
    • Empirical (absolute or relative)
      • Absolute: fixed values with weights
      • Relative: scaling factors with weights
    • Easily extendable (Weibull, etc.)
  • Single-run (run(seed)) and batch-run (run_many([seeds]))
  • Fast array-based batch mode (run_many_arrays)
  • Returns a SimResult: realized times, per-edge durations, and causal predecessors

Note: Defining multiple distributions for the same activity_type will override previous settings.
Always set exactly one distribution per activity type.


Installation

# with poetry
poetry add mc_dagprop

# or with pip
pip install mc_dagprop

Quickstart

from mc_dagprop import (
    EventTimestamp,
    SimEvent,
    SimActivity,
    SimContext,
    GenericDelayGenerator,
    Simulator,
)

# 1) Build your DAG timing context
events = [
    SimEvent("A", EventTimestamp(0.0, 100.0, 0.0)),
    SimEvent("B", EventTimestamp(10.0, 100.0, 0.0)),
]

activities = {
    (0, 1): (0,SimActivity(minimal_duration=60.0, activity_type=1)),
}

precedence = [
    (1, [(0, 0)]),
]

ctx = SimContext(
    events=events,
    activities=activities,
    precedence_list=precedence,
    max_delay=1800.0,
)

# 2) Configure a delay generator (one per activity_type)
gen = GenericDelayGenerator()
gen.add_constant(activity_type=1, factor=1.5)  # only one call for type=1

# 3) Create simulator and run
sim = Simulator(ctx, gen)
result = sim.run(seed=42)
print("Realized times:", result.realized)
print("Edge durations:", result.durations)
print("Causal predecessors:", result.cause_event)

API Reference

EventTimestamp(earliest: float, latest: float, actual: float)

Holds the scheduling window and actual time for one event (node):

  • earliest – earliest possible occurrence
  • latest – latest allowed occurrence
  • actual – scheduled (baseline) timestamp

SimEvent(id: str, timestamp: EventTimestamp)

Wraps a DAG node with:

  • id – string key for the node
  • timestamp – an EventTimestamp instance

SimActivity(minimal_duration: float, activity_type: int)

Represents an edge in the DAG:

  • minimal_duration – minimal (base) duration
  • activity_type – integer type identifier

SimContext(events, activities, precedence_list, max_delay)

Container for your DAG:

  • events: List[SimEvent]
  • activities: Dict[(src_idx, dst_idx), SimActivity]
  • precedence_list: List[(target_idx, [(pred_idx, link_idx), …])]
  • max_delay: overall cap on delay propagation

GenericDelayGenerator

Configurable delay factory (one distribution per activity_type):

  • .add_constant(activity_type, factor)
  • .add_exponential(activity_type, lambda_, max_scale)
  • .add_gamma(activity_type, shape, scale, max_scale=∞)
  • .add_empirical_absolute(activity_type, values, weights)
  • .add_empirical_relative(activity_type, factors, weights)
  • .set_seed(seed)

Simulator(context: SimContext, generator: GenericDelayGenerator)

  • .run(seed: int) → SimResult
  • .run_many(seeds: Sequence[int]) → List[SimResult]

SimResult

  • .realized: NDArray[float] – event times after propagation
  • .durations: NDArray[float] – per-edge durations (base + extra)
  • .cause_event: NDArray[int] – which predecessor caused each event

Visualization Demo

pip install plotly
python -m mc_dagprop.utils.demo_distributions

Displays histograms of realized times and delays.


Development

git clone https://github.com/WonJayne/mc_dagprop.git
cd mc_dagprop
poetry install
poetry run pytest

License

MIT — see LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mc_dagprop-0.3.0.tar.gz (31.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mc_dagprop-0.3.0-cp312-cp312-win_amd64.whl (139.0 kB view details)

Uploaded CPython 3.12Windows x86-64

File details

Details for the file mc_dagprop-0.3.0.tar.gz.

File metadata

  • Download URL: mc_dagprop-0.3.0.tar.gz
  • Upload date:
  • Size: 31.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.10.4 Windows/10

File hashes

Hashes for mc_dagprop-0.3.0.tar.gz
Algorithm Hash digest
SHA256 77ab8122bd2c8a84299ba9bf0cbc44c14a8d7808068a868df62a9e9f349fbcc1
MD5 d7d20f5a63207680e5a988fd68c62763
BLAKE2b-256 6d0f082c5772d3c74903c50b9b46887f0fc8ea7c0eb6ee495031b28ff99e6012

See more details on using hashes here.

File details

Details for the file mc_dagprop-0.3.0-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: mc_dagprop-0.3.0-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 139.0 kB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.10.4 Windows/10

File hashes

Hashes for mc_dagprop-0.3.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 18128dbda9d01672c7b878b1ac4119858fb59f8d96cebfb6c10d6cfd9bc6d944
MD5 039f7303f125fd4d95c991880b607943
BLAKE2b-256 7ac96b1ff777852bd4c1a7be52dd0b0a547b6814de183bae75541e1a4cc1d592

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page