Skip to content

Commit

Permalink
Update readme to use version 0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
caemor committed Oct 28, 2024
1 parent 3fa0f47 commit 98671a7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The [examples](./examples/) folder contains example simulators based on the [off

For a simulator written in Rust to successfully communicate with Mosaik you must:

1. Add `mosaik-api = { git = "https://github.com/ekut-es/mosaik-api" }` to your `Cargo.toml` as a dependency.
1. Add `mosaik-api = "0.1"` to your `Cargo.toml` as a dependency.
2. Implement the `MosaikApi` trait for your simulator.
3. Use the `run_simulation()` function in your `main` to connect your simulator to Mosaik. This connects your simulator to Mosaik and handles the communication over a TCP channel. The `ConnectionDirection` depends on how you connect your simulator to Mosaik in Python (see [Connection Setup](#connection-setup)).
4. Then connect the simulators in the `SIM_CONFIG` of your Mosaik python script as described in the following paragraph.
Expand Down

0 comments on commit 98671a7

Please sign in to comment.