Tutorials
=====

Throughout these tutorials we will showcase and explain `MGSurvE <https://github.com/Chipdelmal/MGSurvE>`_'s features. 
From creating and updating landscapes with traps and different movement kernels, and point-types; to optimizing realistic landscapes, these demos should get us up to speed with using our package.

An important note in the tutorials that deal with optimization routines is that in most of the tutorials we have two ways to do the actual optimization routine:
registering `DEAP <https://deap.readthedocs.io/en/master/>`_'s functions by hand (as most our demos do), or by using our optimization wrappers (the also being available under the "simplified" flag in our `demos folder <https://github.com/Chipdelmal/MGSurvE/tree/main/MGSurvE/demos>`_).
We chose to use the complex version in the tutorials because it allows more flexibility, but for most cases, the simplified versions are more than enough to get landscape optimizations done.

.. toctree::
   :numbered:
   :maxdepth: 1

   Quickstart
   landscapeCreation
   landscapeUpdate
   landscapeTraps
   GA
   GA_custom
   GA_sites
   GA_complex
   OT_trapMask
   GA_STP
   PSO
   GA_discrete
   GA_STPDO


Some other demonstrations of auxiliary tools can be accessed here:

.. toctree::
   :maxdepth: 1

   TrapsKernels


Please note that the code used in all of the tutorials can be downloaded `from this link <https://github.com/Chipdelmal/MGSurvE/tree/main/MGSurvE/demos>`_.

------------

Additionally, all of the demos can be run from our docker container as follows.

1. Pull the image from DockerHub:

.. code-block:: console

   docker pull chipdelmal/mgsurve


2. Run the container and attach the folder for the results:

.. code-block:: console

   docker run \
         -v "$(pwd)"/MGS_demos:/MGSurvE/Demos/demos_out \
         -it chipdelmal/mgsurve:1.0.0.0 bash


3. Navigate to the "Demos" folder where all of the scripts are located:

.. code-block:: console

   cd Demos
   ls


4. Launch the bash script to call all of the experiments:

.. code-block:: console

   ./Demos.sh


This will take a while but all the results will be accessible on the created folder. 



.. image:: ../../img/STP_10_TRP.jpg