# docs/index.rst

pypopRF Documentation

Overview

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.

Key Features

• Feature Extraction: Process multiple geospatial covariates

• Machine Learning: Random Forest-based population prediction

• Dasymetric Mapping: High-resolution population redistribution

• Performance: Parallel processing support for large datasets

• Visualization: Tools for analysis and validation

• CLI: Command-line interface for easy project management

Quick Installation

pip install pypoprf

Quick Start

# Create new project
pypoprf init my_project

# Run analysis
pypoprf run -c my_project/config.yaml

Contents

User Guide

• Installation Guide
  • Prerequisites
  • Installation Methods
• Usage Guide
  • Project Setup
  • Output Files
  • Common Issues
• Examples
  • Basic Usage
  • Common Workflows

Support

• Issue Tracker: https://github.com/wpgp/pypopRF/issues

• Source Code: https://github.com/wpgp/pypopRF

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{pypoprf2024,
  author = {WorldPop SDI},
  title = {pypopRF: Population Prediction and Dasymetric Mapping Tool},
  year = {2024},
  publisher = {GitHub},
  url = {https://github.com/wpgp/pypopRF}
}