[iosefa]

Prepares v0.5.0 for publication to PyPI, Docker Hub, and the documentation site. This is a minor release for the new rumple grid API.

Bumps the package version, declares the missing tqdm dependency, and includes the R test fixtures in the source archive while keeping tests out of the wheel. Also fixes the return annotation that caused the strict docs deployment to fail.

Validation: 185 tests passed, with one slow integration test skipped. CI passes on Python 3.11, 3.12, and 3.13. The strict docs build and Twine checks passed. The built wheel imports and calculates rumple correctly; all 53 rumple tests pass from the source archive.

Release notes

PyForestScan 0.5.0 adds rumple maps calculated from a canopy height model (CHM). The canopy sampling resolution and output resolution are separate: a 1 m CHM can produce a 20 m rumple raster.

Rumple maps

• calculate_rumple_grid() returns a raster and its extent, ready to plot or save as a GeoTIFF.
• Both rumple functions support method="two_triangle" (default) and method="jenness".
• Tiled EPT processing supports metric="rumple", with voxel_size setting the CHM resolution and rumple_resolution setting the output resolution.
• The documentation and notebook explain both methods, missing heights, optional height thresholds, and CHM interpolation.

from pyforestscan import calculate_chm, calculate_rumple_grid

chm, chm_extent = calculate_chm(points, (1, 1), interpolation="linear")
rumple, extent = calculate_rumple_grid(
    chm, (1, 1), grid_resolution=20, extent=chm_extent,
)

calculate_rumple(chm, cell_resolution) returns one value for the whole CHM. Its default numerical results are unchanged. Jenness's missing-height and edge handling matches the raster calculation used by lidR through sp::surfaceArea.

Other fixes

• Tiled processing respects Z bounds that include zero.
• Package metadata declares the tqdm dependency used by tiled processing.
• The source distribution includes the R reference fixtures used by the tests; the wheel contains only the library package.
• Corrected a return annotation in the API documentation that prevented strict documentation builds.

Requires Python 3.11 or newer.

Documentation · Full changelog

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Files with missing lines	Coverage Δ
pyforestscan/calculate.py	79.41% <ø> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.