1
0
mirror of https://github.com/gsi-upm/soil synced 2024-11-21 18:52:28 +00:00

Update README

This commit is contained in:
J. Fernando Sánchez 2023-04-14 19:56:44 +02:00
parent 4e95709188
commit a3fc6a5efa

View File

@ -1,12 +1,13 @@
# [SOIL](https://github.com/gsi-upm/soil) # [SOIL](https://github.com/gsi-upm/soil)
**Note**: Mesa 0.30 introduced many fundamental changes. Check the [documention on how to update your simulations to work with newer versions](docs/notes_v0.30.rst)
Soil is an extensible and user-friendly Agent-based Social Simulator for Social Networks. Soil is an extensible and user-friendly Agent-based Social Simulator for Social Networks.
Learn how to run your own simulations with our [documentation](http://soilsim.readthedocs.io). Learn how to run your own simulations with our [documentation](http://soilsim.readthedocs.io).
Follow our [tutorial](examples/tutorial/soil_tutorial.ipynb) to develop your own agent models. Follow our [tutorial](examples/tutorial/soil_tutorial.ipynb) to develop your own agent models.
> **Warning**
> Mesa 0.30 introduced many fundamental changes. Check the [documention on how to update your simulations to work with newer versions](docs/notes_v0.30.rst)
## Features ## Features
@ -32,7 +33,7 @@ Follow our [tutorial](examples/tutorial/soil_tutorial.ipynb) to develop your own
* Run models in parallel * Run models in parallel
* Save results to different formats * Save results to different formats
* Simulation configuration files * Simulation configuration files
* A command line interface (`soil`), to run multiple * A command line interface (`soil`), to quickly run simulations with different parameters
* An integrated debugger (`soil --debug`) with custom functions to print agent states and break at specific states * An integrated debugger (`soil --debug`) with custom functions to print agent states and break at specific states