diff --git a/docs/flatland_2.0.md b/docs/flatland_2.0.md index e35251dd92d17c15db4b4a905688664a42ea75c3..72f4d54a857e2b9d0acec43bee5200c76b143bd9 100644 --- a/docs/flatland_2.0.md +++ b/docs/flatland_2.0.md @@ -1,19 +1,20 @@ # Flatland 2.0 Introduction -## Whats new +## What's new? -In this version of **Flat**land we are moving closer to realistic and more complex railway problems. Earlier versions of **Flat**land which introduced you to the concept of restricted transitions was still to simplified to give us feasible solutions for daily operations. Thus the following changes are coming in the next version to be closer to real railway network challenges: +In this version of **Flat**land, we are moving closer to realistic and more complex railway problems. +Earlier versions of **Flat**land introduced you to the concept of restricted transitions, but they were still too simplistic to give us feasible solutions for daily operations. +Thus the following changes are coming in the next version to be closer to real railway network challenges: -- **New Level Generator** with less connections between different nodes in the network and thus much higher agent densities on rails. -- **Stochastic Events** that cause agents to stop and get stuck for different number of time steps. +- **New Level Generator** provide less connections between different nodes in the network and thus agent densities on rails are much higher. +- **Stochastic Events** cause agents to stop and get stuck for different numbers of time steps. - **Different Speed Classes** allow agents to move at different speeds and thus enhance complexity in the search for optimal solutions. Below we explain these changes in more detail and how you can play with their parametrization. We appreciate *your feedback* on the performance and the difficulty on these levels to help us shape the best possible **Flat**land 2.0 environment. ## Get the new level generators -Since this is currently still in *beta* phase you can only install this version of **Flat**land through the gitlab repository. Once you have downloaded the [Flatland Repository](https://gitlab.aicrowd.com/flatland/flatland) you have to switch to the [147_new_level_generator](https://gitlab.aicrowd.com/flatland/flatland/tree/147_new_level_generator) branch to be able access the latest changes in **Flat**land. - -Once you have switched to this branch install **Flat**land by running `python setup.py install`. +Since this is currently still in *beta* phase you can only install this version of **Flat**land through the gitlab repository. +Once you have have checkout the latest version from the master, install **Flat**land by running `python setup.py install`. ## Generate levels