soil/docs/index.rst

Welcome to Soil's documentation!
================================

Soil is an opinionated Agent-based Social Simulator in Python focused on Social Networks.

.. image:: soil.png
  :width: 80%
  :align: center

Soil can be installed through pip (see more details in the :doc:`installation` page):

.. code:: bash

    pip install soil


To get started developing your own simulations and agent behaviors, check out our :doc:`Tutorial <soil_tutorial>` and the `examples on GitHub <https://github.com/gsi-upm/soil/tree/master/examples>.

If you use Soil in your research, do not forget to cite this paper:

.. code:: bibtex

    @inbook{soil-gsi-conference-2017,
        author = "S{\'a}nchez, Jes{\'u}s M. and Iglesias, Carlos A. and S{\'a}nchez-Rada, J. Fernando",
        booktitle = "Advances in Practical Applications of Cyber-Physical Multi-Agent Systems: The PAAMS Collection",
        doi = "10.1007/978-3-319-59930-4_19",
        editor = "Demazeau Y., Davidsson P., Bajo J., Vale Z.",
        isbn = "978-3-319-59929-8",
        keywords = "soil;social networks;agent based social simulation;python",
        month = "June",
        organization = "PAAMS 2017",
        pages = "234-245",
        publisher = "Springer Verlag",
        series = "LNAI",
        title = "{S}oil: {A}n {A}gent-{B}ased {S}ocial {S}imulator in {P}ython for {M}odelling and {S}imulation of {S}ocial {N}etworks",
        url = "https://link.springer.com/chapter/10.1007/978-3-319-59930-4_19",
        volume = "10349",
        year = "2017",
    }




.. toctree::
   :maxdepth: 0
   :caption: Learn more about soil:

   installation
   Tutorial <soil_tutorial>

..


.. Indices and tables
   ==================
   * :ref:`genindex`
   * :ref:`modindex`
   * :ref:`search`