Metadata-Version: 2.5
Name: lcfm-shapefiles
Version: 0.9.36
Summary: Package for abstracting asset files (.fgb, .shp), providing syncing and versioning of them using git-lfs, s3 storage versioning
Project-URL: Homepage, https://github.com/VITO-RS-Vegetation/lcfm-shapefiles
Project-URL: Repository, https://github.com/VITO-RS-Vegetation/lcfm-shapefiles
Project-URL: Issues, https://github.com/VITO-RS-Vegetation/lcfm-shapefiles/issues
Author: Filip Schouwenaars
Author-email: Joris Codde <joris.codde@vito.be>, Lagaras Stelios <stelios.lagaras@vito.be>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: geopandas>=1.1.0
Requires-Dist: loguru
Requires-Dist: numpy
Requires-Dist: shapely<3
Provides-Extra: notebooks
Requires-Dist: jupyter; extra == 'notebooks'
Provides-Extra: scripts
Requires-Dist: geopy; extra == 'scripts'
Requires-Dist: matplotlib; extra == 'scripts'
Requires-Dist: requests; extra == 'scripts'
Requires-Dist: satio[legacy]>=2.1.8; extra == 'scripts'
Requires-Dist: tqdm; extra == 'scripts'
Description-Content-Type: text/markdown

[![Auto-Sync LFS Files Github](https://github.com/VITO-RS-Vegetation/lcfm-shapefiles/actions/workflows/auto-sync-github.yml/badge.svg)](https://github.com/VITO-RS-Vegetation/lcfm-shapefiles/actions/workflows/auto-sync-github.yml)

# lcfm-shapefiles

Python wrapper around shapefiles used for the LCFM project.

## Install

From PyPI:

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

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

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

## Use

```python
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](https://github.com/VITO-RS-Vegetation/lcfm-shapefiles/blob/master/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](https://github.com/VITO-RS-Vegetation/lcfm-shapefiles/blob/master/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](https://github.com/VITO-RS-Vegetation/lcfm-shapefiles/blob/master/LICENSE-DATA) for the full breakdown and attribution.

 