tracts.demography.base_parametrized_demography.BaseMigrationEvent

class BaseMigrationEvent(rate_parameter, source_population)

Bases: ABC

Base class for migration events. A migration is an event in which a certain fraction of an admixed population is replaced with migrants from a given source population. Migration events can be pulse events, in which the migration happens at a single time point, or continuous events, in which the migration happens over a time interval with a constant migration rate.

rate_param

The name of the parameter defining the migration rate of the migration event. In a pulse migration event, this is the fraction of the admixed population that is replaced with migrants from the source population. In a continuous migration event, this is the fraction of the admixed population that is replaced with migrants from the source population per generation.

Type:

str

source_population

The population that contributes migrants to the admixed population in the migration event.

Type:

str

__init__(rate_parameter, source_population)

Initializes the migration event. The migration event is defined by the source population and the migration rate.

Parameters:

• rate_parameter (str) – The name of the parameter defining the migration rate of the migration event.

• source_population (str) – The population that contributes migrants to the admixed population in the migration event.