From 53604c1e66395f3ac5fea55601729647fb5d0b63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=2E=20Fernando=20S=C3=A1nchez?= Date: Sun, 9 Dec 2018 13:10:00 +0100 Subject: [PATCH] Fix quickstart.rst markdown code --- docs/quickstart.rst | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 701131c..e5c1182 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -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. 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 ` directly): .. literalinclude:: quickstart.yml :language: yaml -Configuration -============= - -You may :download:`download the file ` directly. The agent type used, SISa, is a very simple model. 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. @@ -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. To make it work, you have to install soil like this: -``` -pip install soil[web] -``` +.. code:: + + pip install soil[web] Once installed, the soil web UI can be run in two ways: -``` -soil-web +.. code:: -OR + soil-web -python -m soil.web -``` \ No newline at end of file + # OR + + python -m soil.web \ No newline at end of file