Dictionnaire (classes et fonctions)¶

Données¶

Les fonctions de données permettent de préparer les données pour la simulation.

simgen.bdsps(file, year=2017, iprint=False, file_format='.dta')¶

Nettoyage de la BDSPS.

Fonction qui permet de mettre en forme la BDSPS.

Paramètres

year (int) – année de la base de départ (défaut=2017)
iprint (boolean) – switch pour imprimer ou non des outputs intermédiaires de cette fonction (défaut=False)

simgen.isq(year)¶

Population par âge de l’ISQ.

Fonction qui permet d’obtenir la population par âge de l’ISQ.

Paramètres: year (int) – année pour la population
Renvoie: dataframe pandas contenant la population par âge (hommes et femmes)
Type renvoyé: dataframe

class simgen.parse¶

Mise en forme des variables pour référence de SimGen.

Classe qui permet de prendre un dataframe provenant d’une base de données particulière et retourner un dataframe propre interprétable par SimGen. On peut faire correspondre les noms de variables avec l’initialisation de la classe en utilisant les dictionnaires map_hh, map_sp et map_kd pour les trois registres.

dominants(data)¶

Mise en forme des dominants.

Fonction membre qui permet de prendre un dataframe dominant et d’appliquer les dictionnaires map_hh pour les noms de variables qui concordent avec SimGen.

Paramètres: data (dataframe) – dataframe de dominants
Renvoie: dataframe avec les noms de variables de SimGen
Type renvoyé: dataframe

kids(data)¶

Mise en forme des enfants.

Fonction membre qui permet de prendre un dataframe enfants et d’appliquer les dictionnaires map_kd pour les noms de variables qui concordent avec SimGen.

Paramètres: data (dataframe) – dataframe d’enfants
Renvoie: dataframe avec les noms de variables de SimGen
Type renvoyé: dataframe

spouses(data)¶

Mise en forme des conjoints.

Fonction membre qui permet de prendre un dataframe conjoint et d’appliquer les dictionnaires map_sp pour les noms de variables qui concordent avec SimGen.

Paramètres: data (dataframe) – dataframe de conjoints
Renvoie: dataframe avec les noms de variables de SimGen
Type renvoyé: dataframe

class simgen.population¶

Structure de population.

Cette classe permet d’abriter sous un seul toit les dominants, conjoints et enfants et permet certaines opérations.

input(hh, sp, kd)¶

Fonction pour entrer les registres.

Fonction qui permet d’entrer les registres dominants, conjoints et enfants qui ont été préalablement passés dans parse().

Paramètres

hh (dataframe) – dataframe des dominants
sp (dataframe) – dataframe des conjoints
kd (dataframe) – dataframe des enfants

Transitions¶

class simgen.update¶

Classe pour les transitions.

Classe permettant d’effectuer différentes transitions d’une année à l’autre.

birth(pop, year, ntarget)¶

Fonction de transitions pour les naissances.

Paramètres

pop (population) – population (instance de la classe population)
year (int) – année de la transition
ntarget (int) – nombre de naissances visé (si alignement)

Renvoie

instance de la classe population

Type renvoyé

population

dead(pop, year)¶

Fonction de transitions pour les décès.

Paramètres

pop (population) – population (instance de la classe population)
year (int) – année de la transition

Renvoie

instance de la classe population

Type renvoyé

population

divorce(pop, year)¶

Fonction de transitions pour les dissolutions d’unions.

Paramètres

pop (population) – population (instance de la classe population)
year (int) – année de la transition

Renvoie

instance de la classe population

Type renvoyé

population

educ(pop, year)¶

Fonction de transitions pour changements de niveau d’éducation.

Paramètres

pop (population) – population (instance de la classe population)
year (int) – année de la transition

Renvoie

instance de la classe population

Type renvoyé

population

emig(pop, year)¶

Fonction de transitions pour gérer l’émigration.

Paramètres

pop (population) – population (instance de la classe population)
year (int) – année de la transition

Renvoie

instance de la classe population

Type renvoyé

population

marriage(pop, year)¶

Fonction de transitions pour les formations d’unions.

Paramètres

pop (population) – population (instance de la classe population)
year (int) – année de la transition

Renvoie

instance de la classe population

Type renvoyé

population

Simulation¶

La classe permettant de réaliser les simulations est model. Voici sa description.

class simgen.model(start_yr=2017, stop_yr=2100)¶

Modèle de simulation SimGen.

Cette classe permet de créer une instance d’un modèle de microsimulation.

Paramètres

start_yr (int) – année de départ de la simulation (défaut=2017)
stop_yr (int) – dernière année de la simulation (défaut=2100)

birth_assumptions(scenario='reference', align=True)¶

Hypothèses de fécondité.

Fonction membre qui permet de spécifier les hypothèses de fécondité.

Paramètres

scenario (str) – Permet de choisir entre les différents scénarios de fécondité produits pas l’ISQ (weak, reference, strong)
aling (boolean) – paramètre permettant d’aligner le nombre d’immigrants sur l’ISQ

dead_assumptions(scenario='medium')¶

Hypothèses de mortalité.

Fonction membre qui permet de spécifier les hypothèses de mortalité.

Paramètres: scenario (str) – Permet de choisir entre les différents scénarios de mortalité produits pas l’STC (low, medium, high)

immig_assumptions(allow=True, num=0.0066, init=None)¶

Hypothèses d’immigration.

Fonction membre qui permet de spécifier les hypothèses d’immigration.

Paramètres

allow (boolean) – paramètre permettant d’aligner le nombre d’immigrants sur l’ISQ
num (float) – immigration totale (nombre); par défaut, scénario de référence de l’ISQ
init (str) – nom du fichier contenant la population d’immigrants

set_statistics(stratas=['age', 'male', 'insch', 'educ', 'married', 'nkids', 'risk_iso'])¶

Fonction déterminant les variables de sortie.

Paramètres: stratas (list) – Liste des variables de sortie

simulate(rep=1)¶

Fonction déclenchant le lancement de la simulation.

Paramètres: stratas (rep) – Nombre de réplications

startpop(file)¶

Charger une population de départ.

Fonction membre qui permet de charger une population de départ.

Paramètres: file (str) – nom du fichier contenant la population de départ

Statistiques¶

Cette classe permet de produire des statistiques dans le cadre d’une simulation.

class simgen.statistics(stratas)¶

Classe pour créer les statistiques provenant d’une simulation.

Cette classe permet de capturer la distribution de la population par strate durant une simulation. Elle permet ensuite de faire plusieurs tableaux dynamiques à partir de ces distributions.

Paramètres: stratas (list of str) – liste des noms de variables du fichiers de dominants afin de stratifier la population et récolter les fréquences (pondérées)

add(pop, year)¶

Fonction pour ajouter une année à la distribution.

À chaque année d’une simulation, cette fonction est invoquée afin de récolter la distribution par strate dans l’année en cours. Cette population est ajoutée à counts.

Paramètres

pop (population) – population de départ (instance de la classe population)
year (int) – année de départ de la simulation

freq(strata=None, bins=[0], sub=None)¶

Fonction de fréquences.

Fonction qui permet, à l’aide de counts, de calculer les fréquences pondérées pour une strate donnée. Deux options sont disponibles: l’une, bins, permet de modifier les catégories de la strate (par exemple le groupe d’âge), tandis que sub permet de définir un critère de sélection particulier pour le calcul des fréquences (en str).

Paramètres

strata (str) – nom de la variable par laquelle on veut découper les données; ne pas spécifier cette option revient à demander les fréquences totales
bins (list of int) – liste de valeurs pour découper les données selon la variable strata; fonctionne seulement avec des variables de types int (pas de str)
sub (str) – condition à respecter pour un sous-échantillon, p.ex. « age>=18 »

Renvoie

dataframe avec les fréquences par année (ligne) et valeur de la strate (colonne)

Type renvoyé

dataframe

prop(strata, bins=[0], sub=None)¶

Fonction de proportions.

Fonction qui permet, à l’aide de counts, de calculer les proportions pondérées pour une strate donnée. Deux options sont disponibles: l’une, bins, permet de modifier les catégories de la strate (par exemple le groupe d’âge), tandis que sub permet de définir un critère de sélection particulier pour le calcul des proportions (en str).

Paramètres

strata (str) – nom de la variable par laquelle on veut découper les données
bins (list of int) – liste de valeurs pour découper les données selon la variable strata; fonctionne seulement avec des variables de types int (pas de str)
sub (str) – condition à respecter pour un sous-échantillon, p.ex. « age>=18 »

Renvoie

dataframe avec les proportions par année (ligne) et valeur de la strate (colonne)

Type renvoyé

dataframe

save(file)¶

Fonction pour sauvegarder les fichiers de fréquences.

Paramètres: file (str) – nom du fichier de sauvegarde, incluant l’extension pkl (format pickle)

start(pop, year)¶

Initialisation de la distribution sur l’année de départ.

Le membre de la classe qui contient les fréquences (counts) est populé pour l’année de départ.

Paramètres

pop (population) – population de départ (instance de la classe population)
year (int) – année de départ de la simulation