ixa 1.0.0

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

use clap::Args;
use ixa::prelude::*;
use ixa::runner::run_with_custom_args;

#[derive(Args, Debug)]
struct CustomArgs {
    // Example of a boolean argument.
    // --say-hello       custom_args.say_hello is true
    // (nothing)         custom_args.say_hello is false
    #[arg(long)]
    say_hello: bool,

    // Example of an optional argument with a required value
    // -p 12            custom_args.starting_population is Some(12)
    // -p               This is invalid; you have to pass a value.
    // (nothing)        custom_args.starting_population is None
    #[arg(short = 'p', long)]
    starting_population: Option<u8>,
}

define_global_property!(Name, String);

fn main() {
    // The runner reads arguments from the command line.
    // args refer to `BaseArgs` (see runner.rs for all available args)
    // custom_args are optional for any arguments you want to define yourself.
    //
    // Try running the following:
    // cargo run --example runner -- --seed 42
    // cargo run --example runner -- --starting-population 5
    // cargo run --example runner -- -p 5 --debugger
    let context = run_with_custom_args(|context, args, custom_args: Option<CustomArgs>| {
        println!("Setting random seed to {}", args.random_seed);

        // As long as you specified a custom type in the signature (CustomArgs),
        // you should assume custom_args is Some (even if no args were passed
        // through the command line). It's None if you didn't specify any custom type.
        let custom_args = custom_args.unwrap();

        if custom_args.say_hello {
            println!("Hello");
        }

        context.set_global_property_value(Name, "Sim123".to_string())?;

        println!("Name: {}", context.get_global_property_value(Name).unwrap());

        if let Some(population) = custom_args.starting_population {
            for _ in 0..population {
                context.add_person(()).unwrap();
            }
        }

        context.add_plan(2.0, |context| {
            println!("Adding two people at t=2");
            context.add_person(()).unwrap();
            context.add_person(()).unwrap();
        });

        Ok(())
    })
    .unwrap();

    let final_count = context.get_current_population();
    println!("Simulation complete. The number of people is: {final_count}");
}