scicom.historicalletters.utils
==============================

.. py:module:: scicom.historicalletters.utils

.. autoapi-nested-parse::

   Utility functions for HistoricalLetters.



Functions
---------

.. autoapisummary::

   scicom.historicalletters.utils.createData
   scicom.historicalletters.utils.getRegion
   scicom.historicalletters.utils.getPositionOnLine
   scicom.historicalletters.utils.getNewTopic


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

.. py:function:: createData(population, populationDistribution)

   Create random coordinates of historically motivated choices.

   The routine samples a population sample based on estimated
   population density of that coordinate.

   The original CSV dataset is retrieved from
   https://doi.org/10.1371/journal.pone.0162678.s003


.. py:function:: getRegion(geometry, model)

   Get region ID overlaping with input geometry.

   Might e.g. fail if line of connection crosses international
   waters, since there is no NUTS region assigned then.


.. py:function:: getPositionOnLine(start, target)

   Interpolate movement along line between two given points.

   The amount of moving from start to target is random.


.. py:function:: getNewTopic(start, target)

   Interpolate new topic between two topics.

   The amount of moving from start to target is random.