Skip to content
/ pypopRF Public

Python package for top-down population disaggregation using Random Forest

License

Notifications You must be signed in to change notification settings

wpgp/pypopRF

Repository files navigation

pypopRF

Documentation License Python DOI

pypopRF is a Python package for population prediction and dasymetric mapping using machine learning techniques. It provides a comprehensive toolkit for processing geospatial data, training models, and generating high-resolution population distribution maps.

Features

  • Feature extraction from multiple geospatial covariates
  • Random Forest-based population prediction with automatic feature selection
  • Parallel processing support for large datasets
  • Dasymetric mapping for high-resolution population redistribution
  • Visualization tools for analysis and validation
  • Command-line interface for easy project management

Quick Installation

pip install pypoprf

Documentation

Full documentation is available at https://wpgp.github.io/pypopRF/

The documentation includes:

  • Detailed installation instructions
  • Usage guide and examples
  • Input data requirements
  • Configuration options
  • Troubleshooting guide

Basic Usage

Initialize Project

# Create a new project
pypoprf init my_project

Run Analysis

# Run with configuration file
pypoprf run -c my_project/config.yaml

Development Setup

  1. Clone the repository:
git clone https://github.com/wpgp/pypopRF.git
cd pypopRF
  1. Create and activate virtual environment:
python -m venv venv
source venv/bin/activate  # Linux/Mac
# or
venv\Scripts\activate.bat  # Windows
  1. Install in development mode:
pip install -e ".[dev,docs]"

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Citation

If you use pypopRF in your research, please cite:

@software{pypoprf2025,
  author = {Priyatikanto R., Nosatiuk B., Zhang W., McKeen T., Vataga E., Tejedor-Garavito N, Bondarenko M.},
  title = {pypopRF: Population Prediction and Dasymetric Mapping Tool},
  year = {2025},
  publisher = {GitHub},
  url = {https://github.com/wpgp/pypopRF}
}

Acknowledgments

  • Developed by WorldPop SDI

About

Python package for top-down population disaggregation using Random Forest

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •