diff --git a/README.md b/README.md index 3c026e0..fd154bf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Arbiter Template -Minimal template for simulating contracts with arbiter. This template is used by the `arbiter init` command when starting new simulations. This template provides a framework for performantly simulating Agent Based Models (ABM) with evm parity. In this model you can think of any things that happens as an action of an agent. Agents can own keys and externally owned accounts, they can interact with each other and they can interact with contracts. This repository has some example agents including a `TokenAdmin`, `BlockAdmin`, and `CounterAgent` which their own functionality and responsibilities. We also give an example of how to parametarize your simulations with a configuration file containing different price paths and price path parameters. These can be played with to see how the simulation changes. Furthermore we provide an api to batch simulations and run them in parallel. This is useful for running many simulations with different parameters. +Minimal template for simulating contracts with arbiter. This template is used by the `arbiter init` command when starting new simulations. This template provides a framework for performantly simulating Agent Based Models (ABM) with evm parity. In this model you can think of any things that happens as an action of an agent. Agents can own keys and externally owned accounts, they can interact with each other and they can interact with smart contracts. + +This repository has some example agents including a [`TokenAdmin`](src/agents/token_admin.rs), [`BlockAdmin`](src/agents/block_admin.rs), and [`CounterAgent`](src/agents/counter_agent.rs) which their own functionality and responsibilities. We also give an example of [how to parametarize your simulations](src/settings/mod.rs) with a configuration file containing different price paths and price path parameters. These can be played with to see how the simulation changes. Furthermore we provide an [api to batch simulations](src/simulations/mod.rs) and run them in parallel. This is useful for running many simulations with different parameters. ### Prerequisites