balkian/soil
1
0
Fork 0
mirror of https://github.com/gsi-upm/soil synced 2024-11-13 23:12:28 +00:00
Code Issues Releases Wiki Activity

Fix quickstart.rst markdown code

Browse Source
This commit is contained in:
J. Fernando Sánchez 2018-12-09 13:10:00 +01:00
parent 01cc8e9128
commit 53604c1e66
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/quickstart.rst
View File

@ -16,15 +16,14 @@ The configuration includes things such as number of agents to use and their type
Soil includes several agent classes in the ``soil.agents`` module, and we will use them in this quickstart. Soil includes several agent classes in the ``soil.agents`` module, and we will use them in this quickstart.
If you are interested in developing your own agents classes, see :doc:`soil_tutorial`. If you are interested in developing your own agents classes, see :doc:`soil_tutorial`.
The configuration is the following:
Configuration
=============
To get you started, we will use this configuration (:download:`download the file <quickstart.yml>` directly):
.. literalinclude:: quickstart.yml .. literalinclude:: quickstart.yml
:language: yaml :language: yaml
Configuration
=============
You may :download:`download the file <quickstart.yml>` directly.
The agent type used, SISa, is a very simple model. The agent type used, SISa, is a very simple model.
It only has three states (neutral, content and discontent), It only has three states (neutral, content and discontent),
Its parameters are the probabilities to change from one state to another, either spontaneously or because of contagion from neighboring agents. Its parameters are the probabilities to change from one state to another, either spontaneously or because of contagion from neighboring agents.
@ -79,16 +78,16 @@ Change some of the parameters, such as the number of agents, the probability of
Soil also includes a web server that allows you to upload your simulations, change parameters, and visualize the results, including a timeline of the network. Soil also includes a web server that allows you to upload your simulations, change parameters, and visualize the results, including a timeline of the network.
To make it work, you have to install soil like this: To make it work, you have to install soil like this:
``` .. code::
pip install soil[web]
``` pip install soil[web]
Once installed, the soil web UI can be run in two ways: Once installed, the soil web UI can be run in two ways:
``` .. code::
soil-web
OR soil-web
python -m soil.web # OR
```
python -m soil.web