API reference
API reference
Full details on all FPsim classes and functions.
| analyzers | Specify the core analyzers available in FPsim. Other analyzers can be |
| arrays | |
| calibration | Define the Calibration class |
| defaults | Define defaults for use throughout FPsim |
| demographics | Methods and functions related to basic demographics such as urban and |
| education | Methods and functions related to education |
| experiment | Define classes and functions for the Experiment class (running sims and comparing them to data) |
| fpmod | Defines the FPmod class |
| interventions | Specify the core interventions available in FPsim. Other interventions can be |
| methods | Contraceptive methods |
| parameters | Handle sim parameters |
| people | Defines the People class |
| plotting | Standard plots used in calibrations and analyses |
| scenarios | Class to define and run scenarios |
| settings | Define options for FPsim, mostly plotting and Numba options. All options should |
| sim | Defines the Sim class, the core class of the FP model (FPsim). |
| utils | File for storing utilities and probability calculators needed to run FP model |