Metadata-Version: 2.4
Name: fpsim
Version: 3.5.3
Summary: FPsim: Family Planning Simulator
Author: Annie Valente, Cliff Kerr, Robyn Stuart, Paula Sanz-Leon, Aasli Nur, Ryan Hull, Daniel Klein, Emily Driano, Marita Zimmermann
Author-email: Michelle O'Brien <info@fpsim.org>
License: MIT License
        
        Copyright (c) 2019-2024 Bill & Melinda Gates Foundation
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Website, http://fpsim.org
Project-URL: Source, https://github.com/fpsim/fpsim/
Keywords: family planning,women's health,agent-based model,simulation
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: numba
Requires-Dist: scipy
Requires-Dist: starsim>=3.1.0
Requires-Dist: pandas>=1.3
Requires-Dist: sciris>=2.1.0
Requires-Dist: matplotlib>=3.5.0
Requires-Dist: seaborn>=0.9
Requires-Dist: optuna
Provides-Extra: dev
Requires-Dist: pytest>=7.4; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-env; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Requires-Dist: mkdocs; extra == "dev"
Requires-Dist: mkdocs-material; extra == "dev"
Requires-Dist: mkdocstrings[python]; extra == "dev"
Requires-Dist: mkdocs-include-markdown-plugin; extra == "dev"
Requires-Dist: mkdocs-jupyter; extra == "dev"
Dynamic: license-file

# FPsim: Family Planning Simulator

This repository contains the code for the Institute for Disease Modeling's family planning simulator, FPsim.

**FPsim is currently under development**.

## User guide

FPsim is designed as an open-source tool for family planning research.
However, it is not a silver bullet tool. It is designed to answer
complex questions about emerging dynamics in complex social and behavioral systems. Its strength stems from a life-course approach,
which allows researchers to examine how compounding and temporal effects unfold over women's lives, and how these individual-level changes lead to macro-level outcomes.

Before using FPsim, please refer to the following guidelines:

 * FPsim is only as good as the data and assumptions provided. Be sure you are familiar with both before using FPsim.
 * FPsim is not a replacement for good data. The model cannot tell you what demand for a hypothetical method will be.
 * FPsim is not a replacement for descriptive statistics. Before using FPsim, assess your primary research question(s). Can they be answered using descriptive statistics?
 * FPsim cannot predict exogenous events. Use caution when interpreting and presenting results. For example, FPsim cannot predict regional conflicts or pandemics, nor their impacts on FP services.


## Repo structure

The structure is as follows:

- FPsim, in the folder `fpsim`, is a standalone Python library for performing family planning analyses.
- Within `fpsim`, the `locations` folder contains parameters and input data for all countries currently calibrated.
- Docs are in the `docs` folder.
- Examples are in the `examples` folder.
- Tests are in the `tests` folder.


## Installation

Run `pip install fpsim` to install and its dependencies from PyPI. Alternatively, clone the repository and run `pip install -e .` (including the final dot!). To be able to run tests and build the docs as well, use `pip install -e .[dev]`.


## Documentation

Documentation is available at https://docs.fpsim.org.


## Disclaimer

The code in this repository was developed by IDM and other collaborators to support our joint research on family planning. We've made it publicly available under the MIT License to provide others with a better understanding of our research and an opportunity to build upon it for their own work. Note that FPsim depends on a number of user-installed Python packages that can be installed automatically via `pip install`. We make no representations that the code works as intended or that we will provide support, address issues that are found, or accept pull requests. You are welcome to create your own fork and modify the code to suit your own modeling needs as contemplated under the MIT License. See the contributing and code of conduct READMEs for more information.
