landlab.components.species_evolution.base_taxon

Base Taxon of SpeciesEvolver.

class Taxon

Bases: ABC

Base Taxon of SpeciesEvolver.

A SpeciesEvolver Taxon represents a group of organisms. Examples of groups represented by this object include an analogue group (e.g., seed plants in general, a specific trout species), a taxonomic level (e.g., phylum, species, population). More generally, Taxon subclasses act as approaches to simulate evolution of biologic groups. Taxon was designed to represent biologic groups, although they could be individual organisms.

This class is intended to be subclassed. Subclasses must implement the attributes and methods of this base class that are designated as abstract. The methods must take the same parameters and both the attributes and methods must return the values described in their docstrings.

Instantiate a Taxon object.

A base taxon object cannot be instantiated. This initialization method can be called by super in the initialization method of a subclass to set initial values of required private properties.

__init__()

Instantiate a Taxon object.

A base taxon object cannot be instantiated. This initialization method can be called by super in the initialization method of a subclass to set initial values of required private properties.

__new__(**kwargs)

property extant

The living state of the taxon.

The taxon lives at the current model time if True. The taxon is extinct as of the current model time if False.

property parent

The parent taxon.

The parent is the taxon object that produced this object. A value of None indicates no parent taxon.

abstract property range_mask

A mask of the taxon geographic extent.

The range mask is a boolean numpy array where True values indicate where the taxon is located in the model grid associated with a SpeciesEvolver instance.

This property must be implemented in a subclass.

property tid

The identifier of the taxon.

The identifier is an integer automatically and uniquely assigned by SpeciesEvolver once the component begins tracking the taxon. It is read-only as it should not be changed once this parameter is set.