geost.bro.BroCptGeopackage.from_geopackage#

classmethod BroCptGeopackage.from_geopackage(file: str | Path, **gpd_kwargs)[source]#

Create an instance of BroCptGeopackage from a GeoPackage file.

Parameters:
  • file (str or Path) – The path to the GeoPackage file.

  • **gpd_kwargs (dict) – Additional keyword arguments to pass to gpd.read_file. The ‘fid_as_index’ argument is set to True by default to retain the index fordatabase selections. The ‘layer’ argument should not be passed as it is set internally and this will raise a ValueError.

Return type:

BroCptGeopackage

Raises:

ValueError – If the ‘layer’ argument is passed in gpd_kwargs. This argument is set internally to set the gdf attribute and cannot be overwritten.