Skip to content

API Reference

Full reference for the craeft public API. All primary symbols are re-exported from the package root:

from craeft import (
    # Generation
    configuration_model,
    random_graph,
    sample_network,
    # Generator implementations
    ErdosRenyiGenerator,
    ConfigurationModelGenerator,
    PoissonNetworkGenerator,
    BigVRewiringGenerator,
    MotifDecompositionGenerator,
    # Metrics
    global_clustering_coefficient,
    is_connected,
    DisconnectedGraphError,
    # Motifs
    G2, G8, G14, K6, Motif,
    # Orchestration
    Experiment, ExperimentResult,
    # Simulation
    EpidemicSimulator, SIRSimulator,
)

Subpackages

Package Description
craeft.networks.generation Network generator protocol and implementations
craeft.networks.generation.configuration_model CCM pipeline (partition, connectors, pairing, assembly)
craeft.networks.generation.motifs Motif definitions and registry
craeft.networks.generation.distributions Degree distribution sampling
craeft.networks.metrics Clustering coefficients, connectivity
craeft.networks.rewiring Big-V and motif decomposition
craeft.point_processes Gillespie engine and core abstractions
craeft.point_processes.epidemics SIR model
craeft.experiment Experiment orchestration
craeft.utils.plotting Visualisation