Skip to main content

A package for finding the number of people residing near environmental hazards

Project description

popexposure: Functions to estimate the number of people living near environmental hazards

Python License: MIT GitHub PyPI version

Overview

popexposure is an open-source Python package providing fast, memory-efficient, and consistent estimates of the number of people living near environmental hazards, enabling environmental epidemiologists to assess population-level exposure to environmental hazards based on residential proximity. Methodological details can be found in McBrien et al (2025). Extensive documentation can be found on in our quick start tutorial.

Installation

The easiest way to install popexposure is via the latest pre-compiled binaries from PyPI with:

pip install popexposure

You can build popexposure from source as you would any other Python package with:

git clone https://github.com/heathermcb/popexposure
cd popexposure
python -m pip install .

Tutorials

A number of tutorials providing worked examples using popexposure can be found in our demos folder.

Quickstart

import glob
import pandas as pd
from popexposure.find_exposure import PopEstimator

# Instantiate estimator
pop_est = PopEstimator()

# Wrangle filepaths
hazard_paths = sorted(glob.glob("*hazard*"))  # Adjust pattern as needed
pop_path = "my_pop_raster.tif"
admin_units_path = "my_admin_units.geojson"

# Prepare admin units data
admin_units = pop_est.prep_data(admin_units_path, geo_type="spatial_unit")

# Find total num ppl residing <= 10km of each hazard in 2016, 2017, 2018
exposed_list = []

for i, hazard_path in enumerate(hazard_paths):
    # Prepare hazard data for this year
    hazards = pop_est.prep_data(hazard_path, geo_type="hazard")
    # Estimate exposed population
    exposed = pop_est.exposed_pop(
        pop_path=pop_path,
        hazard_specific=False,  # set to True if you want per-hazard results
        hazards=hazards,
        spatial_units=admin_units
    )
    exposed_list['year'] = 2016 + i
    exposed_list.append(exposed)

exposed_df = pd.concat(exposed_list, axis=0)

# Save output
exposed_df.to_parquet("pop_exposed_to_hazards.parquet")

Available functions

Function Overview Inputs Outputs
prep_data Reads, cleans, and preprocesses geospatial hazard or admin unit data. Path to hazard or spatial unit file (.geojson or .parquet), geo_type ("hazard" or "spatial_unit") Cleaned GeoDataFrame with valid geometries
exposed_pop Estimates number of people living within hazard buffer(s) using a raster Population raster path (.tif), hazard data, hazard_specific (bool), optional spatial units DataFrame with exposed population counts by hazard/spatial unit
pop Estimates total population in admin geographies using a raster Population raster path (.tif), spatial unit data (GeoDataFrame) DataFrame with total population per spatial unit

Getting help and contributing

If you have any questions, a feature request, or would like to report a bug, please open an issue. We also welcome any new contributions and ideas. If you want to add code, please submit a pull request and we will get back to you when we can. Thanks!

Citing this package

Please cite our paper McBrien et al (2025).

Authors

References

Our package is a fancy wrapper for the package exactextract.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

popexposure-1.0.0.dev7.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

popexposure-1.0.0.dev7-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file popexposure-1.0.0.dev7.tar.gz.

File metadata

  • Download URL: popexposure-1.0.0.dev7.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.6 Darwin/22.6.0

File hashes

Hashes for popexposure-1.0.0.dev7.tar.gz
Algorithm Hash digest
SHA256 0861356bfc7a96bc581c497493cf19c822cf4af9aa148938a5226be5925ea761
MD5 77cb67d8ba80dc8a948fe22dd004b96c
BLAKE2b-256 447fec42b18c6cd7c3b7b373802c4492e750c7142e42a9ba696e9f1df682ae49

See more details on using hashes here.

File details

Details for the file popexposure-1.0.0.dev7-py3-none-any.whl.

File metadata

  • Download URL: popexposure-1.0.0.dev7-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.6 Darwin/22.6.0

File hashes

Hashes for popexposure-1.0.0.dev7-py3-none-any.whl
Algorithm Hash digest
SHA256 9d5d6feea5aac5bb2a87efa5e9d87e3f94735864f7b9519e7577167f6889456c
MD5 248ce97f7f690d18a843dec70d45183f
BLAKE2b-256 6f161dd1b46398b7705ada1d1be8986119aa5e399857f36b8a27892f22519eb3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page