API reference¶
Subpackages¶
- fpsim.locations package
- Submodules
- fpsim.locations.calibrate_manual module
- fpsim.locations.ethiopia module
scalar_pars()
data2interp()
filenames()
age_pyramid()
age_mortality()
maternal_mortality()
infant_mortality()
miscarriage()
stillbirth()
female_age_fecundity()
fecundity_ratio_nullip()
lactational_amenorrhea()
sexual_activity()
sexual_activity_pp()
debut_age()
exposure_age()
exposure_parity()
birth_spacing_pref()
methods()
method_probs()
barriers()
make_pars()
- fpsim.locations.kenya module
scalar_pars()
data2interp()
filenames()
age_pyramid()
age_mortality()
maternal_mortality()
infant_mortality()
miscarriage()
stillbirth()
female_age_fecundity()
fecundity_ratio_nullip()
lactational_amenorrhea()
sexual_activity()
sexual_activity_pp()
debut_age()
exposure_age()
exposure_parity()
birth_spacing_pref()
methods()
method_probs()
barriers()
make_pars()
- fpsim.locations.senegal module
scalar_pars()
data2interp()
filenames()
age_pyramid()
age_mortality()
maternal_mortality()
infant_mortality()
miscarriage()
stillbirth()
female_age_fecundity()
fecundity_ratio_nullip()
lactational_amenorrhea()
sexual_activity()
sexual_activity_pp()
debut_age()
exposure_age()
exposure_parity()
birth_spacing_pref()
methods()
method_probs()
barriers()
make_pars()
- Submodules
Submodules¶
- fpsim.analyzers module
- fpsim.base module
- fpsim.calibration module
Calibration
Calibration.set_optuna_defaults()
Calibration.configure_optuna()
Calibration.validate_pars()
Calibration.run_exp()
Calibration.run_trial()
Calibration.worker()
Calibration.run_workers()
Calibration.remove_db()
Calibration.make_study()
Calibration.calibrate()
Calibration.summarize()
Calibration.parse_study()
Calibration.to_json()
Calibration.plot_trend()
Calibration.plot_all()
Calibration.plot_best()
Calibration.plot_stride()
- fpsim.defaults module
- fpsim.experiment module
Experiment
Experiment.load_data()
Experiment.extract_data()
Experiment.pop_growth_rate()
Experiment.run_model()
Experiment.post_process_sim()
Experiment.extract_model()
Experiment.model_pop_size()
Experiment.model_mcpr()
Experiment.model_mmr()
Experiment.model_infant_mortality_rate()
Experiment.model_crude_death_rate()
Experiment.model_crude_birth_rate()
Experiment.model_data_tfr()
Experiment.model_data_asfr()
Experiment.extract_skyscrapers()
Experiment.extract_birth_spacing()
Experiment.extract_methods()
Experiment.compute_fit()
Experiment.post_process_results()
Experiment.run()
Experiment.compare()
Experiment.summarize()
Experiment.to_json()
Experiment.plot()
Fit
compute_gof()
diff_summaries()
- fpsim.interventions module
- fpsim.parameters module
- fpsim.scenarios module
- fpsim.settings module
- fpsim.sim module
People
People.update_method()
People.update_method_pp()
People.update_methods()
People.check_mortality()
People.check_sexually_active()
People.check_conception()
People.make_pregnant()
People.check_lam()
People.update_breastfeeding()
People.update_postpartum()
People.update_pregnancy()
People.reset_breastfeeding()
People.check_maternal_mortality()
People.check_infant_mortality()
People.check_delivery()
People.update_age()
People.update_age_bin_totals()
People.log_age_split()
People.track_mcpr()
People.track_cpr()
People.track_acpr()
People.init_step_results()
People.update()
Sim
Sim.initialize()
Sim.init_results()
Sim.get_age_sex()
Sim.make_people()
Sim.init_people()
Sim.update_methods()
Sim.update_mortality()
Sim.update_mothers()
Sim.apply_interventions()
Sim.apply_analyzers()
Sim.finalize_interventions()
Sim.finalize_analyzers()
Sim.run()
Sim.store_postpartum()
Sim.to_df()
Sim.conform_y_axes()
Sim.plot()
Sim.plot_age_first_birth()
Sim.compute_method_usage()
Sim.format_method_df()
MultiSim
parallel()
- fpsim.utils module
- fpsim.version module