Supported Python API surface

This is the exhaustive list of supported public imports from the biosimulant package in 0.0.20. Names not listed here are implementation details and may change without notice. The compatibility biosim import path exposes the same runtime APIs for existing projects.

Core composition

from biosimulant import (
    BioWorld, WorldEvent,
    BioModule, SignalEmitterBioModule, StatefulBioModule,
    WiringBuilder, build_from_spec, load_wiring, load_wiring_toml,
    load_wiring_yaml,
)

Use BioWorld, BioModule, and WiringBuilder for their contracts.

Signals and visuals

from biosimulant import (
    BioSignal, AcceptedSignalProfile, ScalarSignal, ArraySignal,
    RecordSignal, EventSignal, InputValueType, SignalSpec,
    unwrap_payload, coerce_float, scalar_or_record_input, make_signal,
    validate_connection_specs, validate_port_spec_direction,
    VisualSpec, validate_visual_spec, normalize_visuals,
)

See BioSignal & Metadata and the Visualization Contract.

Lab packaging

from biosimulant import (
    build_package, export_lab_package, fetch_package, publish_package,
    run_package, unpack_package, validate_package,
)

For supported CLI workflows and archive layout, see the lab manifest reference and CLI reference.

Hub-backed local composition

from biosimulant.hub import (
    HubComposition, LOCK_FILE_NAME, dependency_directory,
    materialize_vendored_lab,
)

HubComposition is intentionally in biosimulant.hub, rather than the root namespace, to make dependency resolution an explicit choice. See the HubComposition API.

Managed Developer API

from biosimulant import (
    Client, AsyncClient, Run, RunResult, Artifact,
    ApiError, AuthenticationError, ValidationError, RateLimitError,
    InsufficientCreditsError, RunFailed, RunTimeout,
    verify_webhook_signature,
)

Client and AsyncClient submit accessible versioned Hub Labs to managed infrastructure; they do not change local BioWorld.run() behavior. See the Developer API, Python examples, and errors reference.

Optional machine-learning helper

from biosimulant import OnnxClassifierModule

This helper is imported lazily and requires the optional ML dependencies:

pip install "biosimulant[ml]"

Version

from biosimulant import __version__

HubComposition API BioSignal & Metadata