API reference

Subpackages

• fpsim.locations package
  • Submodules
    • 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

• fpsim.analyzers module
  • Analyzer
    • Analyzer.initialize()
    • Analyzer.finalize()
    • Analyzer.apply()
    • Analyzer.to_json()
  • snapshot
    • snapshot.apply()
  • timeseries_recorder
    • timeseries_recorder.initialize()
    • timeseries_recorder.apply()
    • timeseries_recorder.plot()
  • timeseries_recorder.self.i
  • timeseries_recorder.self.t
  • timeseries_recorder.self.y
  • timeseries_recorder.self.keys
  • timeseries_recorder.self.data
  • age_pyramids
    • age_pyramids.initialize()
    • age_pyramids.apply()
    • age_pyramids.plot()
    • age_pyramids.plot3d()
  • age_pyramids.self.bins
  • age_pyramids.self.data
  • verbose_sim
    • verbose_sim.apply()
    • verbose_sim.save()
    • verbose_sim.story()
• fpsim.base module
  • ParsObj
    • ParsObj.update_pars()
  • BasePeople
    • BasePeople.keys()
    • BasePeople.is_female
    • BasePeople.is_male
    • BasePeople.int_age
    • BasePeople.ceil_age
    • BasePeople.int_age_clip
    • BasePeople.n
    • BasePeople.inds
    • BasePeople.len_inds
    • BasePeople.len_people
    • BasePeople.plot()
    • BasePeople.filter()
    • BasePeople.unfilter()
    • BasePeople.binomial()
  • BaseSim
    • BaseSim.year2ind()
    • BaseSim.ind2year()
    • BaseSim.ind2calendar()
    • BaseSim.npts
    • BaseSim.tvec
    • BaseSim.n
    • BaseSim.get_interventions()
    • BaseSim.get_intervention()
    • BaseSim.get_analyzers()
    • BaseSim.get_analyzer()
• 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.extract_age_pregnancy()
    • Experiment.compute_fit()
    • Experiment.post_process_results()
    • Experiment.run()
    • Experiment.compare()
    • Experiment.summarize()
    • Experiment.to_json()
    • Experiment.plot()
  • Fit
    • Fit.compute()
    • Fit.reconcile_inputs()
    • Fit.compute_diffs()
    • Fit.compute_gofs()
    • Fit.compute_losses()
    • Fit.compute_mismatch()
    • Fit.plot()
  • compute_gof()
  • diff_summaries()
• fpsim.interventions module
  • Intervention
    • Intervention.disp()
    • Intervention.initialize()
    • Intervention.finalize()
    • Intervention.apply()
    • Intervention.plot_intervention()
    • Intervention.to_json()
  • change_par
    • change_par.initialize()
    • change_par.apply()
    • change_par.finalize()
  • update_methods
    • update_methods.apply()
• fpsim.parameters module
  • Pars
    • Pars.copy()
    • Pars.to_dict()
    • Pars.to_json()
    • Pars.from_json()
    • Pars.validate()
    • Pars.update_method_eff()
    • Pars.update_method_prob()
    • Pars.reset_methods_map()
    • Pars.add_method()
    • Pars.rm_method()
    • Pars.reorder_methods()
  • pars()
• fpsim.scenarios module
  • make_scen()
  • Scenario
    • Scenario.update_label()
    • Scenario.run()
  • Scenarios
    • Scenarios.add_scen()
    • Scenarios.make_sims()
    • Scenarios.make_scens()
    • Scenarios.run()
    • Scenarios.check_run()
    • Scenarios.plot()
    • Scenarios.plot_sims()
    • Scenarios.analyze_sims()
• 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
    • MultiSim.run()
    • MultiSim.compute_stats()
    • MultiSim.merge()
    • MultiSim.split()
    • MultiSim.remerge()
    • MultiSim.to_df()
    • MultiSim.plot()
    • MultiSim.plot_age_first_birth()
  • parallel()
• fpsim.utils module
  • set_seed()
  • bt()
  • bc()
  • rbt()
  • mt()
  • sample()
• fpsim.version module