gabm.abm.attributes.gender module

Gender module for GABM.

class gabm.abm.attributes.gender.Gender(gender_id: GenderID, description: str)

Bases: GABMAttribute

A Gender.

Attributes:: id (GenderID): Unique identifier for the gender. description (str): The description of the gender.

class gabm.abm.attributes.gender.GenderID(gender_id: int)

Bases: GABMAttributeID

A unique identifier for a Gender attribute.

Attributes:: id (int): The unique identifier for the gender.

FEMALE = GenderID(1)

MALE = GenderID(2)

NON_BINARY = GenderID(3)

UNKNOWN = GenderID(0)

class gabm.abm.attributes.gender.GenderMap

Bases: GABMAttributeMap

A mapping of GenderIds to Genders.

By default, the map is initialized as follows:

items: Dict[GenderID, Gender] = {
    GenderID.UNKNOWN: Gender(GenderID.UNKNOWN, "unknown"),
    GenderID.FEMALE: Gender(GenderID.FEMALE, "female"),
    GenderID.MALE: Gender(GenderID.MALE, "male"),
    GenderID.NON_BINARY: Gender(GenderID.NON_BINARY, "non-binary"),
}
super().__init__(items)