Skip to main content

pbg-basic-processes

Reusable, composite-agnostic process-bigraph processes — the small, generic building blocks that show up in almost every workspace.

Process What it does
Clock Emits an integer tick step counter each step — the one temporal quantity the engine does not expose as a store. (Absolute simulation time, global_time, is already maintained by the engine in every composite; wire any input to ['global_time'] to read it.)
Tick Accumulates continuous simulation time into a float t store (t -> t + interval each update) — a wireable time signal for processes/steps that are functions of t (e.g. a time-driven MathExpressionStep).
Intervention Applies a specific perturbation to one target store — set / knockout / scale / add / decouple / invert, optionally within a time window. The building block for negative controls and counterfactuals.
MathExpressionStep Evaluates a list of named symbolic (SymPy) expressions as one Step, inferring input ports from free symbols and resolving inter-expression dependencies in topological order.

Auto-registration

Like pbg-emitters, these processes auto-register into any workspace core. allocate_core() walks every installed distribution that depends on bigraph-schema and registers its Process/Step subclasses — no entry points, no register_* boilerplate:

from bigraph_schema import allocate_core

core = allocate_core()
assert 'Clock' in core.link_registry          # just by being installed
assert 'Intervention' in core.link_registry
assert 'MathExpressionStep' in core.link_registry

Add pbg-basic-processes as a dependency of your workspace (it is a base dependency of pbg-superpowers, so every pbg workspace gets it) and reference the processes by local:Clock, local:Tick, local:Intervention, local:MathExpressionStep.

Plotting helpers (optional)

viva_basic_processes.plotting provides two notebook/tutorial convenience helpers — plot_timeseries (line plots of emitted records over a time column) and plot_single_eval (a bar chart of one step's inputs/outputs). They require matplotlib, which is an optional extra so the core processes stay lightweight:

pip install "viva-basic-processes[plotting]"
from viva_basic_processes import plot_timeseries, plot_single_eval

Install

pip install pbg-basic-processes            # from PyPI (when published)
pip install -e .                           # from a checkout

Usage

Node-builder helpers make wiring into a composite easy:

from pbg_basic_processes import clock_node, intervention_node

state = {
    'tick': 0,
    'nutrient': 5.0,
    'clock': clock_node(interval=1.0),          # writes a step counter to ['tick']
    # hold nutrient at 0 only between t=10 and t=20 of absolute sim time.
    # use_global_time wires the window to the engine's reserved global_time store.
    'starve': intervention_node(['nutrient'], mode='set', value=0.0,
                                window=[10, 20], use_global_time=True),
}

Develop

pip install -e '.[dev]'
pytest -q

MIT-licensed. Part of the vivarium-collective process-bigraph ecosystem.

Metadata

Release files for pbg-basic-processes 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pbg-basic-processes 0.3.0
File Size Uploaded
pbg_basic_processes-0.3.0.tar.gz 15.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pbg-basic-processes 0.3.0
File Interpreter ABI Platform
pbg_basic_processes-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 32.1 kB

Release files / pbg_basic_processes-0.3.0.tar.gz

Download URL pbg_basic_processes-0.3.0.tar.gz
Size 15.8 kB
Tags Source
SHA-256 checksum
How to use checksums
3f761b00c7d501b9944277ff2c5a062885297ad9ba3d26ab4aca84f76963b8a6
BLAKE2b-256 checksum
How to use checksums
b75cb7dd36afdb3ff0a5ba7149b94939faf5d79ce6b4452080b59536d1943a9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

Release files / pbg_basic_processes-0.3.0-py3-none-any.whl

Download URL pbg_basic_processes-0.3.0-py3-none-any.whl
Size 16.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d6c3245aca0cfbbb581b34bf6c09d34558a9da1c7af9587eeb4d5145b9a39ebc
BLAKE2b-256 checksum
How to use checksums
5975a531a33eedfe78e4d8daefdece1aec586ff2f4d9cbdd407b02ef7e71ba1d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page