Motivate

Setup

Install rust using rustup

Running Motivate

Configuration

config/parameters.yaml

```yaml

totalyears: the number of years the simulation runs for numberofpeople: the number of people in the simulation numberofsimulations: the number of simulations to run in parallel socialconnectivity: how connected an agent is to its social network subcultureconnectivity: how connected an agent is to its subculture neighbourhoodconnectivity: how connected an agent is to its neighbourhood numberofsocialnetworklinks: the minimum number of links an agent should have in its social network numberofneighbourlinks: the minimum number of neighbours an agent should be influenced by daysinhabitaverage: the number of days that account for approximately 86% of the habit average distributions: this should not be changed ```

config/scenario.yaml

```yaml

id: the name of the scenario subcultures: <- these are the subcultures in the scenario, currently an equal amount of agents in each - id: Subculture A <- the name of the subculture desirability: <- the desirability scores of transport modes in the subculture from 0 - 1 PublicTransport: 0.5 Walk: 0.699999988079071 Car: 0.800000011920929 Cycle: 0.8999999761581421 < other subcultures omitted > neighbourhoods: - id: "0" <- the name of the subulture supportiveness: <- how supportive the neighbourhood is for a transport mode Cycle: 0.699999988079071 Walk: 0.800000011920929 Car: 0.8999999761581421 PublicTransport: 0.8999999761581421 capacity: <- the maximum capacity at which there is no congestion penalty Car: 3600 Cycle: 150000 Walk: 150000 PublicTransport: 3000 < other neighbourhoods omitted > numberofbikes: 10000 <- How many bikes are in the scenario numberofcars: 5000 <- How many cars are in the scenario intervention: <- The intervention that should occur day: 365 <- The day at which the intervention takes place neighbourhoodchanges: - id: "0" <- The ID of the neighbourhood to change increaseinsupportiveness: <- How to change the supportiveness, be careful that this does not make the supportiveness < 0 or > 1 Car: -0.1 Cycle: 0.1 < fields with no change are not required > increaseincapacity: <- Be careful this does not make the capacity < 0 Car: -4000 PublicTransport: -100 < if there is no increaseinsupportiveness or increaseincapacity the respective field can be left out e.g. > - id: "1" increaseincapacity: Car: -100 - id: "2" increaseinsupportiveness: Walk: 0.4 Cycle: 0.3 < other changes to the neighbourhood can be added in the same way > subculturechanges: - id: Subculture A <- The ID of the Subculture to change increaseindesirability: <- How to change the desirability, be careful that this does not make the desirability < 0 or > 1 Car: -0.1 Cycle: 0.1 < fields with no change are not required > < other changes to the subculture can be added in the same way > changeinnumberofbikes: 10000 <- An increase (or decrease) in the number of bikes changeinnumberofcars: -100 <- An increase (or decrease) in the number of cars ```

Running the simulation

On the first run of the simulation run cargo run --release -- --generate, so that social networks are generated.

Afterwards in the root of the repository run cargo run --release.

Generating Documentation

Documentation can be generated by running cargo rustdoc -- --document-private-items

Notes

As specified in .cargo/config the generated executable will target the cpu it is compiled on, therefore binaries created on one system, may not execute on other systems, even if they run the same operating system. To remove this requirement remove -C target_cpu=native from .cargo/config, however this could have an impact on performance.