ixa 2.0.0-beta2.3

A framework for building agent-based models
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

//! A framework for building discrete-event simulations
//!
//! Ixa is a framework designed to support the creation of large-scale
//! discrete event simulations. The primary use case is the construction of
//! agent-based models for disease transmission, but the approach is applicable
//! in a wide array of circumstances.
//!
//! The central object of an Ixa simulation is the `Context` that is
//! responsible for managing all the behavior of the simulation. All of the
//! simulation-specific logic is embedded in modules that rely on the `Context`
//! for core services such as:
//! * Maintaining a notion of time for the simulation
//! * Scheduling events to occur at some point in the future and executing them
//!   at that time
//! * Holding module-specific data so that the module and other modules can
//!   access it
//!
//! In practice, a simulation usually consists of a set of modules that work
//! together to provide all of the functions of the simulation. For instance,
//! a simple disease transmission model might consist of the
//! following modules:
//! * A population loader that initializes the set of people represented
//!   by the simulation.
//! * An infection seeder that introduces the pathogen into the population.
//! * A disease progression manager that transitions infected people through
//!   stages of disease until recovery.
//! * A transmission manager that models the process of an infected
//!   person trying to infect susceptible people in the population.
//!
//! ## Features
//!
//! - **`logging`**: enables structured logging for native and wasm targets.
//! - **`progress_bar`**: enables the timeline progress bar for long-running simulations.
//! - **`profiling`**: enables collection and reporting of execution profiling statistics. Disabled by default.

#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/docs/book/src/cli-usage.md"))]

pub mod context;
pub use context::{Context, ContextBase, ExecutionPhase, IxaEvent};

mod plugin_context;
pub use plugin_context::PluginContext;

mod data_plugin;
pub use data_plugin::*;

pub mod error;
pub use error::IxaError;

pub mod global_properties;
pub use global_properties::{ContextGlobalPropertiesExt, GlobalProperty};

pub mod network;
pub use network::{ContextNetworkExt, Edge, EdgeType};

pub mod macros;

pub mod plan;
pub mod random;
pub use random::{ContextRandomExt, RngId};

pub mod report;
pub use report::{ConfigReportOptions, ContextReportExt, Report};

pub mod runner;
pub use runner::{run_with_args, run_with_custom_args, BaseArgs};

pub mod log;
pub use log::{
    debug, disable_logging, enable_logging, error, info, set_log_level, set_module_filter,
    set_module_filters, trace, warn, LevelFilter,
};

#[cfg(feature = "progress_bar")]
pub mod progress;

pub mod hashing;
pub mod numeric;

// Re-export for macros
pub use csv;
pub use ctor;
pub use ixa_derive::{
    canonical_from_sorted_query_parts_closure, impl_make_canonical, impl_people_make_canonical,
    reorder_closure, sorted_tag, sorted_value_type, unreorder_closure,
};
pub use paste;
pub use rand;
pub use rkyv;

// Deterministic hashing data structures
pub use crate::hashing::{HashMap, HashMapExt, HashSet, HashSetExt};

// Preludes
pub mod prelude;

pub mod prelude_for_plugins {
    pub use ixa_derive::IxaEvent;

    pub use crate::context::{ContextBase, IxaEvent};
    pub use crate::define_data_plugin;
    pub use crate::error::IxaError;
    pub use crate::prelude::*;
}

pub mod entity;
pub use entity::{ContextEntitiesExt, EntityPropertyTuple};

pub mod execution_stats;
pub mod profiling;

pub mod data_structures;

#[cfg(all(target_arch = "wasm32", feature = "progress_bar"))]
compile_error!(
    "Target `wasm32` and feature `progress_bar` are mutually exclusive — enable at most one."
);

// The following is a workaround for an ICE involving wasm-bindgen:
// https://github.com/CDCgov/ixa/actions/runs/16283417455/job/45977349528?pr=464
#[cfg(target_family = "wasm")]
use wasm_bindgen::prelude::wasm_bindgen;

// See: https://github.com/rustwasm/wasm-bindgen/issues/4446
#[cfg(target_family = "wasm")]
mod wasm_workaround {
    extern "C" {
        pub(super) fn __wasm_call_ctors();
    }
}

// See: https://github.com/rustwasm/wasm-bindgen/issues/4446
#[cfg(target_family = "wasm")]
#[wasm_bindgen(start)]
fn start() {
    // fix:
    // Error: Read a negative address value from the stack. Did we run out of memory?
    #[cfg(target_family = "wasm")]
    unsafe {
        wasm_workaround::__wasm_call_ctors()
    };
}