.. _app_examples:

********
Examples
********

In order to try the plugin, one of these examples is a good way to proceed. Make sure
you have :ref:`configured <app_configuration>` the plugin before.

.. toctree::
   :maxdepth: 3

Geo Schelling
=============

The Geo Schelling example builds a SHoB network and runs the schelling model on that network.

.. code-block:: python

	import shobnetpy as sn
	sn.run_geo_schelling.prepare()
	sn.run_geo_schelling.run()
	
This will use the existing hexagon shapefiles of the package to build the network and run the
Geo Schelling model for 10 simulation steps.

To test the creation of hexagon shapefiles, pass the parameter `use_existing_shapes=False`:
Note that you need to :ref:`setup GQIS path <app_configuration>` before.

.. code-block:: python

	import shobnetpy as sn
	sn.run_geo_schelling.prepare()
	sn.run_geo_schelling.run(use_existing_shapes=False)



|Geo Schelling Network Visualisation|

.. |Geo Schelling Network Visualisation| image:: ./../geo_schelling_network.png