oscar_colony.optimise.surplus_summary.create_surplus_summary#

oscar_colony.optimise.surplus_summary.create_surplus_summary(required_n_per_genotype, n_matings_per_scheme, offspring_per_scheme)[source]#

Create a summary of the total and surplus numbers for the given combination of breeding schemes.

Parameters:

  • required_n_per_genotype (dict[tuple[Genotype, ...], int]) – Required number of individuals of each genotype

  • n_matings_per_scheme (dict[BreedingScheme, int]) – Optimal number of matings per breeding scheme

  • offspring_per_scheme (dict[BreedingScheme, ExpectedOffspring]) – The estimated number of offspring produced per mating of each breeding scheme

Returns:

Summary of total and surplus numbers

Return type:

SurplusSummary