lcfm-shapefiles

Python wrapper around shapefiles used for the LCFM project.

Install

From PyPI:

uv add lcfm-shapefiles
# or: pip install lcfm-shapefiles

From VITO's internal Artifactory (VITO-only):

uv add --index https://artifactory.vgt.vito.be/artifactory/api/pypi/python-packages/simple lcfm-shapefiles

Use

import lcfm_shapefiles import list_filepaths, get_filepath
import geopandas as gpd

# List out all available files; you can index this list to get a path
lcfm_shapefiles.list_filepaths()

# Get path a specific file
fp = lcfm_shapefiles.get_filepath("LCFM_1p_S2-tiles.fgb")

# Import fgb into a geopandas data frame
gdf = gpd.read_file(fp)

Develop

See README-dev.md for development setup, CI/CD, and internal VITO infrastructure details.

License

The Python source code is licensed under the MIT License - see LICENSE.

The shapefile/grid data shipped in src/lcfm_shapefiles/data/ is licensed under CC BY-SA 4.0, except two files derived from OpenStreetMap land polygons (generated by scripts/land_buffer.py), which are ODbL 1.0 licensed - see LICENSE-DATA for the full breakdown and attribution.