FPsim documentation

FPsim is a stochastic agent-based model, written in Python, for exploring and analyzing family planning. In addition, the repository contains scripts for analyzing model output and tests for testing functionality.

Full contents

• FPsim overview
  • User Guide
  • Repo Structure
  • Installation
  • Documentation
  • Contributing
  • Disclaimer
• Tutorials
  • Getting started
    • Hello world
    • Defining parameters and running simulations
  • Scenarios
  • Scenario plotting
  • Customize plotting
• What’s new
  • Version 0.28.1 (2024-04-11)
  • Version 0.27.0 (2024-02-09)
  • Version 0.26.8 (2024-02-08)
  • Version 0.26.7 (2023-10-24)
  • Version 0.26.6 (2023-9-27)
  • Version 0.26.5 (2023-9-27)
  • Version 0.26.4 (2023-9-27)
  • Version 0.26.3 (2023-9-27)
  • Version 0.26.2 (2023-7-25)
  • Version 0.26.1 (2023-6-29)
  • Version 0.26.0 (2023-5-31)
  • Version 0.25.0 (2023-5-13)
  • Version 0.24.1 (2023-4-14)
  • Version 0.24.0 (2023-3-17)
  • Version 0.23.2 (2023-3-6)
  • Version 0.23.1 (2023-2-28)
  • Version 0.23.0 (2023-2-10)
  • Version 0.22.1 (2023-2-03)
  • Version 0.22.0 (2023-1-24)
  • Version 0.21.2 (2022-12-16)
  • Version 0.21.1 (2022-12-09)
  • Version 0.21.0 (2022-12-06)
  • Version 0.20.0 (2022-11-30)
  • Version 0.19.2 (2022-10-28)
  • Version 0.19.1 (2022-10-26)
  • Version 0.19.0 (2022-09-01)
  • Version 0.18.2 (2022-08-12)
  • Version 0.18.1 (2022-08-08)
  • Version 0.18.0 (2022-08-01)
  • Version 0.17.5 (2022-07-28)
  • Version 0.17.4 (2022-07-27)
  • Version 0.17.3 (2022-07-18)
  • Version 0.17.2 (2022-07-15)
  • Version 0.17.1 (2022-07-14)
  • Version 0.17.0 (2022-07-08)
  • Version 0.16.2 (2022-07-01)
  • Version 0.16.1 (2022-06-30)
  • Version 0.16.0 (2022-06-28)
  • Version 0.15.0 (2022-06-13)
  • Version 0.14.2 (2022-06-06)
  • Version 0.14.2 (2022-05-31)
  • Version 0.14.1 (2022-05-27)
  • Version 0.14.0 (2022-05-26)
  • Version 0.13.2 (2022-05-25)
  • Version 0.13.1 (2022-05-25)
  • Version 0.13.0 (2022-05-23)
  • Version 0.12.0 (2022-05-22)
  • Version 0.11.5 (2022-05-21)
  • Version 0.11.4 (2022-05-20)
  • Version 0.11.3 (2022-05-20)
  • Version 0.11.2 (2022-05-20)
  • Version 0.11.1 (2022-05-20)
  • Version 0.11.0 (2022-05-20)
  • Version 0.10.7 (2022-05-19)
  • Version 0.10.6 (2022-05-19)
  • Version 0.10.5 (2022-05-18)
  • Version 0.10.4 (2022-05-17)
  • Version 0.10.3 (2022-05-12)
  • Version 0.10.2 (2022-05-10)
  • Version 0.10.1 (2022-05-09)
  • Version 0.10.0 (2022-05-08)
  • Version 0.9.0 (2022-05-05)
  • Version 0.8.0 (2021-08-28)
  • Version 0.7.3 (2021-07-15)
  • Version 0.7.2 (2021-07-14)
  • Version 0.7.1 (2021-07-14)
  • Version 0.7.0 (2021-06-29)
  • Version 0.6.5 (2021-06-11)
  • Version 0.6.4 (2021-06-10)
  • Version 0.6.3 (2021-06-10)
  • Version 0.6.2 (2021-05-10)
  • Version 0.6.1 (2021-05-02)
  • Version 0.6.0 (2021-05-01)
  • Version 0.5.2 (2021-04-30)
  • Version 0.5.1 (2021-04-29)
• API reference
  • analyzers
    • Analyzer
    • snapshot
    • age_pyramids
    • empowerment_recorder
    • education_recorder
  • base
    • ParsObj
    • BasePeople
    • BaseSim
    • ndict
  • calibration
    • Calibration
  • defaults
    • State
  • experiment
    • Experiment
    • Fit
    • compute_gof
    • diff_summaries
  • interventions
    • Intervention
    • change_par
    • update_methods
  • parameters
    • Pars
    • pars
  • scenarios
    • Scenario
    • Scenarios
    • make_scen
  • settings
  • sim
    • Sim
    • MultiSim
    • parallel
  • utils
    • set_seed
    • bt
    • bc
    • rbt
    • mt
    • sample
    • match_ages
    • fpsim.utils.DuplicateNameException
  • fpsim.locations
    • ethiopia
    • ethiopia_regions
    • kenya
    • senegal