Source code for pyro_risks.datasets.masks

# Copyright (C) 2021, Pyronear contributors.

# This program is licensed under the GNU Affero General Public License version 3.
# See LICENSE or go to <https://www.gnu.org/licenses/agpl-3.0.txt> for full license details.

import logging
import geopandas as gpd
from typing import Optional

from pyro_risks import config as cfg


__all__ = ["get_french_geom"]


[docs]def get_french_geom(path: Optional[str] = None) -> gpd.GeoDataFrame:
    """Creates the dataframe with the geometry of French departments

    Args:
        path: optional path to your local geojson
    """
    if isinstance(path, str):
        return gpd.read_file(path)
    else:
        try:
            return gpd.read_file(cfg.FR_GEOJSON)
        except Exception:
            logging.warning(f"Unable to access {cfg.FR_GEOJSON}, trying fallback.")
            return gpd.read_file(cfg.FR_GEOJSON_FALLBACK)