scicom.historicalletters.space
==============================

.. py:module:: scicom.historicalletters.space

.. autoapi-nested-parse::

   The geographical space for HistoricalLetters.



Classes
-------

.. autoapisummary::

   scicom.historicalletters.space.Nuts2Eu


Module Contents
---------------

.. py:class:: Nuts2Eu

   Bases: :py:obj:`mesa_geo.GeoSpace`


   Define regions containing senders of letters.

   The space model is initialized with all EU NUTS2 regions.
   The movement of one agent during the model run consitst of
   the removing the sender from the old region, setting the
   new sender position and then adding the sender to the new
   region.

   This is modified from a mesa-geo example, here
   https://github.com/projectmesa/mesa-examples/blob/main/gis/geo_schelling_points/geo_schelling_points/space.py


   .. py:attribute:: _id_region_map


   .. py:method:: add_regions(agents)

      Add regions to space.



   .. py:method:: add_sender_to_region(agent, region_id)

      Add sender to region.



   .. py:method:: remove_sender_from_region(agent)

      Remove sender from region.



   .. py:method:: add_sender(agent, regionID)

      Add sender to specific region.



   .. py:method:: move_sender(agent, pos, regionID)

      Move sender from old to new region.



   .. py:method:: __remove_sender(agent)

      Remove sender.