ImmigrationOperator#

class pybrops.breed.arch.ImmigrationOperator.ImmigrationOperator[source]#

Bases: BreedingEdge

Abstract class defining immigration operators.

The purpose of this abstract class is to define functionality for:
  1. Protocols for immigration between different breeding nodes.

Methods

immigrate

Immigrate individuals from a BreedingNode.

abstract immigrate(bnode, **kwargs)[source]#

Immigrate individuals from a BreedingNode.

Parameters:
  • bnode (BreedingNode) – A BreedingNode object from which to pull individuals.

  • kwargs (dict) – Additional keyword arguments.

Returns:

kwindiv – Dictionary of data from individuals selected.

Return type:

dict