tunned-geobr 0.2.2__py3-none-any.whl → 0.2.4__py3-none-any.whl

tunned_geobr/read_og_unconventional_resources.py

@@ -0,0 +1,129 @@
+import geopandas as gpd
+import requests
+import shutil
+import zipfile
+import tempfile
+import warnings
+import os
+from shapely.geometry.point import Point
+
+
+def read_og_unconventional_resources(simplified=False, verbose=False):
+    """Download data of unconventional oil and gas resources in Brazil.
+
+    This function downloads and returns data of unconventional oil and gas resources
+    (Recursos Não Convencionais) in Brazil as a GeoPandas GeoDataFrame. 
+    The data comes from EPE (Energy Research Company).
+
+    Parameters
+    ----------
+    simplified : bool, optional
+        If True, returns a simplified version of the dataset with only the most
+        important columns. If False, returns the complete dataset. Default is False.
+    verbose : bool, optional
+        If True, displays detailed messages about the download and processing
+        steps. Default is False.
+
+    Returns
+    -------
+    gpd.GeoDataFrame
+        A GeoDataFrame containing data on unconventional oil and gas resources in Brazil.
+
+    Raises
+    ------
+    Exception
+        If the download or processing of the data fails.
+
+    Example
+    -------
+    >>> from tunned_geobr import read_og_unconventional_resources
+    >>> 
+    >>> # Read the data
+    >>> unconventional = read_og_unconventional_resources()
+    >>> 
+    >>> # Plot the data
+    >>> unconventional.plot()
+    """
+    
+    if verbose:
+        print("Downloading data of unconventional oil and gas resources in Brazil")
+    
+    # Define the URL for the API request
+    url = "https://gisepeprd2.epe.gov.br/arcgis/rest/services/Download_Dados_Webmap_EPE/GPServer/Extract%20Data%20Task/execute?f=json&env%3AoutSR=102100&Layers_to_Clip=%5B%22Recursos%20N%C3%A3o%20Convencionais%22%5D&Area_of_Interest=%7B%22geometryType%22%3A%22esriGeometryPolygon%22%2C%22features%22%3A%5B%7B%22geometry%22%3A%7B%22rings%22%3A%5B%5B%5B-9237395.881983705%2C-4650539.310904562%5D%2C%5B-9237395.881983705%2C1219824.4613954136%5D%2C%5B-2349502.3891517334%2C1219824.4613954136%5D%2C%5B-2349502.3891517334%2C-4650539.310904562%5D%2C%5B-9237395.881983705%2C-4650539.310904562%5D%5D%5D%2C%22spatialReference%22%3A%7B%22wkid%22%3A102100%7D%7D%7D%5D%2C%22sr%22%3A%7B%22wkid%22%3A102100%7D%7D&Feature_Format=Shapefile%20-%20SHP%20-%20.shp&Raster_Format=Tagged%20Image%20File%20Format%20-%20TIFF%20-%20.tif"
+    
+    try:
+        # Make the API request
+        response = requests.get(url)
+        response.raise_for_status()
+        
+        # Parse the JSON response
+        data = response.json()
+        
+        # Extract the URL for the zip file
+        if 'results' in data and len(data['results']) > 0 and 'value' in data['results'][0]:
+            download_url = data['results'][0]['value']['url']
+        else:
+            raise Exception("Failed to extract download URL from API response")
+        
+        # Create a temporary directory to store the downloaded files
+        with tempfile.TemporaryDirectory() as temp_dir:
+            # Download the zip file
+            zip_path = os.path.join(temp_dir, "og_unconventional_resources.zip")
+            if verbose:
+                print("Downloading zip file")
+            
+            response = requests.get(download_url, stream=True)
+            response.raise_for_status()
+            
+            with open(zip_path, 'wb') as f:
+                response.raw.decode_content = True
+                shutil.copyfileobj(response.raw, f)
+            
+            # Extract the zip file
+            if verbose:
+                print("Extracting files")
+            
+            with zipfile.ZipFile(zip_path, 'r') as zip_ref:
+                zip_ref.extractall(temp_dir)
+            
+            # Find the shapefile in the extracted files
+            shp_files = [f for f in os.listdir(temp_dir) if f.endswith('.shp')]
+            
+            if not shp_files:
+                raise Exception("No shapefile found in the downloaded zip file")
+            
+            # Read the shapefile
+            if verbose:
+                print("Reading shapefile")
+            
+            shp_path = os.path.join(temp_dir, shp_files[0])
+            gdf = gpd.read_file(shp_path)
+            
+            # Convert to SIRGAS 2000 (EPSG:4674)
+            if verbose:
+                print("Converting to SIRGAS 2000 (EPSG:4674)")
+            
+            gdf = gdf.to_crs(epsg=4674)
+            
+            # Simplify the dataset if requested
+            if simplified:
+                if verbose:
+                    print("Simplifying the dataset")
+                
+                # Select only the most important columns
+                # Adjust these columns based on the actual data structure
+                cols_to_keep = ['TIPO', 'BACIA', 'FORMACAO', 'UF', 'geometry']
+                cols_available = [col for col in cols_to_keep if col in gdf.columns]
+                
+                if not cols_available:
+                    warnings.warn("None of the specified columns for simplification are available. Returning the full dataset.")
+                else:
+                    gdf = gdf[cols_available]
+            
+            if verbose:
+                print("Finished processing unconventional oil and gas resources data")
+            
+            return gdf
+    
+    except Exception as e:
+        raise Exception(f"Failed to download or process unconventional oil and gas resources data: {str(e)}")

tunned_geobr/read_oil_and_derivatives_terminal.py

@@ -0,0 +1,128 @@
+import geopandas as gpd
+import requests
+import shutil
+import zipfile
+import tempfile
+import warnings
+import os
+from shapely.geometry.point import Point
+
+
+def read_oil_and_derivatives_terminal(simplified=False, verbose=False):
+    """Download data of oil and derivatives terminals in Brazil.
+
+    This function downloads and returns data of oil and derivatives terminals
+    in Brazil as a GeoPandas GeoDataFrame. The data comes from EPE (Energy Research Company).
+
+    Parameters
+    ----------
+    simplified : bool, optional
+        If True, returns a simplified version of the dataset with only the most
+        important columns. If False, returns the complete dataset. Default is False.
+    verbose : bool, optional
+        If True, displays detailed messages about the download and processing
+        steps. Default is False.
+
+    Returns
+    -------
+    gpd.GeoDataFrame
+        A GeoDataFrame containing data on oil and derivatives terminals in Brazil.
+
+    Raises
+    ------
+    Exception
+        If the download or processing of the data fails.
+
+    Example
+    -------
+    >>> from tunned_geobr import read_oil_and_derivatives_terminal
+    >>> 
+    >>> # Read the data
+    >>> oil_terminals = read_oil_and_derivatives_terminal()
+    >>> 
+    >>> # Plot the data
+    >>> oil_terminals.plot()
+    """
+    
+    if verbose:
+        print("Downloading data of oil and derivatives terminals in Brazil")
+    
+    # Define the URL for the API request
+    url = "https://gisepeprd2.epe.gov.br/arcgis/rest/services/Download_Dados_Webmap_EPE/GPServer/Extract%20Data%20Task/execute?f=json&env%3AoutSR=102100&Layers_to_Clip=%5B%22Terminais%20de%20Petr%C3%B3leo%20e%20Derivados%22%5D&Area_of_Interest=%7B%22geometryType%22%3A%22esriGeometryPolygon%22%2C%22features%22%3A%5B%7B%22geometry%22%3A%7B%22rings%22%3A%5B%5B%5B-8655251.47456396%2C-4787514.465591563%5D%2C%5B-8655251.47456396%2C1229608.401015912%5D%2C%5B-3508899.2341809804%2C1229608.401015912%5D%2C%5B-3508899.2341809804%2C-4787514.465591563%5D%2C%5B-8655251.47456396%2C-4787514.465591563%5D%5D%5D%2C%22spatialReference%22%3A%7B%22wkid%22%3A102100%7D%7D%7D%5D%2C%22sr%22%3A%7B%22wkid%22%3A102100%7D%7D&Feature_Format=Shapefile%20-%20SHP%20-%20.shp&Raster_Format=Tagged%20Image%20File%20Format%20-%20TIFF%20-%20.tif"
+    
+    try:
+        # Make the API request
+        response = requests.get(url)
+        response.raise_for_status()
+        
+        # Parse the JSON response
+        data = response.json()
+        
+        # Extract the URL for the zip file
+        if 'results' in data and len(data['results']) > 0 and 'value' in data['results'][0]:
+            download_url = data['results'][0]['value']['url']
+        else:
+            raise Exception("Failed to extract download URL from API response")
+        
+        # Create a temporary directory to store the downloaded files
+        with tempfile.TemporaryDirectory() as temp_dir:
+            # Download the zip file
+            zip_path = os.path.join(temp_dir, "oil_terminals.zip")
+            if verbose:
+                print("Downloading zip file")
+            
+            response = requests.get(download_url, stream=True)
+            response.raise_for_status()
+            
+            with open(zip_path, 'wb') as f:
+                response.raw.decode_content = True
+                shutil.copyfileobj(response.raw, f)
+            
+            # Extract the zip file
+            if verbose:
+                print("Extracting files")
+            
+            with zipfile.ZipFile(zip_path, 'r') as zip_ref:
+                zip_ref.extractall(temp_dir)
+            
+            # Find the shapefile in the extracted files
+            shp_files = [f for f in os.listdir(temp_dir) if f.endswith('.shp')]
+            
+            if not shp_files:
+                raise Exception("No shapefile found in the downloaded zip file")
+            
+            # Read the shapefile
+            if verbose:
+                print("Reading shapefile")
+            
+            shp_path = os.path.join(temp_dir, shp_files[0])
+            gdf = gpd.read_file(shp_path)
+            
+            # Convert to SIRGAS 2000 (EPSG:4674)
+            if verbose:
+                print("Converting to SIRGAS 2000 (EPSG:4674)")
+            
+            gdf = gdf.to_crs(epsg=4674)
+            
+            # Simplify the dataset if requested
+            if simplified:
+                if verbose:
+                    print("Simplifying the dataset")
+                
+                # Select only the most important columns
+                # Adjust these columns based on the actual data structure
+                cols_to_keep = ['NOME', 'EMPRESA', 'TIPO', 'CAPACIDADE', 'UF', 'MUNICIPIO', 'geometry']
+                cols_available = [col for col in cols_to_keep if col in gdf.columns]
+                
+                if not cols_available:
+                    warnings.warn("None of the specified columns for simplification are available. Returning the full dataset.")
+                else:
+                    gdf = gdf[cols_available]
+            
+            if verbose:
+                print("Finished processing oil and derivatives terminals data")
+            
+            return gdf
+    
+    except Exception as e:
+        raise Exception(f"Failed to download or process oil and derivatives terminals data: {str(e)}")

tunned_geobr/read_pan_strategic_areas 2.py

@@ -0,0 +1,71 @@
+import geopandas as gpd
+import requests
+from io import BytesIO
+
+def read_pan_strategic_areas(simplified=False):
+    """Download ICMBio's Strategic Areas data.
+    
+    This function downloads and processes the Strategic Areas data from ICMBio
+    (Chico Mendes Institute for Biodiversity Conservation) using their WFS service.
+    The data includes strategic areas for biodiversity conservation planning.
+    Original source: ICMBio - Instituto Chico Mendes de Conservação da Biodiversidade
+    
+    Parameters
+    ----------
+    simplified : boolean, by default False
+        If True, returns a simplified version of the dataset with fewer columns
+        
+    Returns
+    -------
+    gpd.GeoDataFrame
+        Geodataframe with ICMBio's strategic areas data
+        
+    Example
+    -------
+    >>> from tunned_geobr import read_pan_strategic_areas
+    
+    # Read strategic areas data
+    >>> strategic_areas = read_pan_strategic_areas()
+    """
+    
+    url = "https://geoservicos.inde.gov.br/geoserver/ICMBio/ows?request=GetFeature&service=WFS&version=1.0.0&typeName=ICMBio:pan_icmbio_areas_estrat_052024_a&outputFormat=json"
+    
+    try:
+        # Download the GeoJSON data
+        response = requests.get(url)
+        if response.status_code != 200:
+            raise Exception("Failed to download strategic areas data from ICMBio WFS")
+            
+        # Read the GeoJSON directly into a GeoDataFrame
+        gdf = gpd.read_file(BytesIO(response.content))
+        
+        # Convert to SIRGAS 2000 (EPSG:4674) if not already
+        if gdf.crs is None or gdf.crs.to_epsg() != 4674:
+            gdf = gdf.to_crs(4674)
+        
+        if simplified:
+            # Keep only the most relevant columns
+            # Note: Column names may need adjustment based on actual data
+            columns_to_keep = [
+                'geometry',
+                'nome',          # Area name
+                'tipo',          # Type of strategic area
+                'bioma',         # Biome
+                'uf',            # State
+                'area_ha',       # Area in hectares
+                'descricao',     # Description
+                'importancia',   # Importance
+                'data_criacao'   # Creation date
+            ]
+            
+            # Filter columns that actually exist in the dataset
+            existing_columns = ['geometry'] + [col for col in columns_to_keep[1:] if col in gdf.columns]
+            gdf = gdf[existing_columns]
+    
+    except Exception as e:
+        raise Exception(f"Error downloading strategic areas data: {str(e)}")
+        
+    return gdf
+
+if __name__ == '__main__':
+    read_pan_strategic_areas()

tunned_geobr/read_pio_ducts.py

@@ -0,0 +1,128 @@
+import geopandas as gpd
+import requests
+import shutil
+import zipfile
+import tempfile
+import warnings
+import os
+from shapely.geometry.point import Point
+
+
+def read_pio_ducts(simplified=False, verbose=False):
+    """Download data of PIO (Oil Products and Other Liquids) ducts in Brazil.
+
+    This function downloads and returns data of PIO ducts
+    in Brazil as a GeoPandas GeoDataFrame. The data comes from EPE (Energy Research Company).
+
+    Parameters
+    ----------
+    simplified : bool, optional
+        If True, returns a simplified version of the dataset with only the most
+        important columns. If False, returns the complete dataset. Default is False.
+    verbose : bool, optional
+        If True, displays detailed messages about the download and processing
+        steps. Default is False.
+
+    Returns
+    -------
+    gpd.GeoDataFrame
+        A GeoDataFrame containing data on PIO ducts in Brazil.
+
+    Raises
+    ------
+    Exception
+        If the download or processing of the data fails.
+
+    Example
+    -------
+    >>> from tunned_geobr import read_pio_ducts
+    >>> 
+    >>> # Read the data
+    >>> pio_ducts = read_pio_ducts()
+    >>> 
+    >>> # Plot the data
+    >>> pio_ducts.plot()
+    """
+    
+    if verbose:
+        print("Downloading data of PIO ducts in Brazil")
+    
+    # Define the URL for the API request
+    url = "https://gisepeprd2.epe.gov.br/arcgis/rest/services/Download_Dados_Webmap_EPE/GPServer/Extract%20Data%20Task/execute?f=json&env%3AoutSR=102100&Layers_to_Clip=%5B%22Dutos%20PIO%22%5D&Area_of_Interest=%7B%22geometryType%22%3A%22esriGeometryPolygon%22%2C%22features%22%3A%5B%7B%22geometry%22%3A%7B%22rings%22%3A%5B%5B%5B-8655251.47456396%2C-4787514.465591563%5D%2C%5B-8655251.47456396%2C1229608.401015912%5D%2C%5B-3508899.2341809804%2C1229608.401015912%5D%2C%5B-3508899.2341809804%2C-4787514.465591563%5D%2C%5B-8655251.47456396%2C-4787514.465591563%5D%5D%5D%2C%22spatialReference%22%3A%7B%22wkid%22%3A102100%7D%7D%7D%5D%2C%22sr%22%3A%7B%22wkid%22%3A102100%7D%7D&Feature_Format=Shapefile%20-%20SHP%20-%20.shp&Raster_Format=Tagged%20Image%20File%20Format%20-%20TIFF%20-%20.tif"
+    
+    try:
+        # Make the API request
+        response = requests.get(url)
+        response.raise_for_status()
+        
+        # Parse the JSON response
+        data = response.json()
+        
+        # Extract the URL for the zip file
+        if 'results' in data and len(data['results']) > 0 and 'value' in data['results'][0]:
+            download_url = data['results'][0]['value']['url']
+        else:
+            raise Exception("Failed to extract download URL from API response")
+        
+        # Create a temporary directory to store the downloaded files
+        with tempfile.TemporaryDirectory() as temp_dir:
+            # Download the zip file
+            zip_path = os.path.join(temp_dir, "pio_ducts.zip")
+            if verbose:
+                print("Downloading zip file")
+            
+            response = requests.get(download_url, stream=True)
+            response.raise_for_status()
+            
+            with open(zip_path, 'wb') as f:
+                response.raw.decode_content = True
+                shutil.copyfileobj(response.raw, f)
+            
+            # Extract the zip file
+            if verbose:
+                print("Extracting files")
+            
+            with zipfile.ZipFile(zip_path, 'r') as zip_ref:
+                zip_ref.extractall(temp_dir)
+            
+            # Find the shapefile in the extracted files
+            shp_files = [f for f in os.listdir(temp_dir) if f.endswith('.shp')]
+            
+            if not shp_files:
+                raise Exception("No shapefile found in the downloaded zip file")
+            
+            # Read the shapefile
+            if verbose:
+                print("Reading shapefile")
+            
+            shp_path = os.path.join(temp_dir, shp_files[0])
+            gdf = gpd.read_file(shp_path)
+            
+            # Convert to SIRGAS 2000 (EPSG:4674)
+            if verbose:
+                print("Converting to SIRGAS 2000 (EPSG:4674)")
+            
+            gdf = gdf.to_crs(epsg=4674)
+            
+            # Simplify the dataset if requested
+            if simplified:
+                if verbose:
+                    print("Simplifying the dataset")
+                
+                # Select only the most important columns
+                # Adjust these columns based on the actual data structure
+                cols_to_keep = ['NOME', 'EMPRESA', 'EXTENSAO', 'DIAMETRO', 'UF', 'geometry']
+                cols_available = [col for col in cols_to_keep if col in gdf.columns]
+                
+                if not cols_available:
+                    warnings.warn("None of the specified columns for simplification are available. Returning the full dataset.")
+                else:
+                    gdf = gdf[cols_available]
+            
+            if verbose:
+                print("Finished processing PIO ducts data")
+            
+            return gdf
+    
+    except Exception as e:
+        raise Exception(f"Failed to download or process PIO ducts data: {str(e)}")

tunned_geobr/read_pio_terminals.py

@@ -0,0 +1,128 @@
+import geopandas as gpd
+import requests
+import shutil
+import zipfile
+import tempfile
+import warnings
+import os
+from shapely.geometry.point import Point
+
+
+def read_pio_terminals(simplified=False, verbose=False):
+    """Download data of PIO (Oil Products and Other Liquids) terminals in Brazil.
+
+    This function downloads and returns data of PIO terminals
+    in Brazil as a GeoPandas GeoDataFrame. The data comes from EPE (Energy Research Company).
+
+    Parameters
+    ----------
+    simplified : bool, optional
+        If True, returns a simplified version of the dataset with only the most
+        important columns. If False, returns the complete dataset. Default is False.
+    verbose : bool, optional
+        If True, displays detailed messages about the download and processing
+        steps. Default is False.
+
+    Returns
+    -------
+    gpd.GeoDataFrame
+        A GeoDataFrame containing data on PIO terminals in Brazil.
+
+    Raises
+    ------
+    Exception
+        If the download or processing of the data fails.
+
+    Example
+    -------
+    >>> from tunned_geobr import read_pio_terminals
+    >>> 
+    >>> # Read the data
+    >>> pio_terminals = read_pio_terminals()
+    >>> 
+    >>> # Plot the data
+    >>> pio_terminals.plot()
+    """
+    
+    if verbose:
+        print("Downloading data of PIO terminals in Brazil")
+    
+    # Define the URL for the API request
+    url = "https://gisepeprd2.epe.gov.br/arcgis/rest/services/Download_Dados_Webmap_EPE/GPServer/Extract%20Data%20Task/execute?f=json&env%3AoutSR=102100&Layers_to_Clip=%5B%22Terminais%20PIO%22%5D&Area_of_Interest=%7B%22geometryType%22%3A%22esriGeometryPolygon%22%2C%22features%22%3A%5B%7B%22geometry%22%3A%7B%22rings%22%3A%5B%5B%5B-8655251.47456396%2C-4787514.465591563%5D%2C%5B-8655251.47456396%2C1229608.401015912%5D%2C%5B-3508899.2341809804%2C1229608.401015912%5D%2C%5B-3508899.2341809804%2C-4787514.465591563%5D%2C%5B-8655251.47456396%2C-4787514.465591563%5D%5D%5D%2C%22spatialReference%22%3A%7B%22wkid%22%3A102100%7D%7D%7D%5D%2C%22sr%22%3A%7B%22wkid%22%3A102100%7D%7D&Feature_Format=Shapefile%20-%20SHP%20-%20.shp&Raster_Format=Tagged%20Image%20File%20Format%20-%20TIFF%20-%20.tif"
+    
+    try:
+        # Make the API request
+        response = requests.get(url)
+        response.raise_for_status()
+        
+        # Parse the JSON response
+        data = response.json()
+        
+        # Extract the URL for the zip file
+        if 'results' in data and len(data['results']) > 0 and 'value' in data['results'][0]:
+            download_url = data['results'][0]['value']['url']
+        else:
+            raise Exception("Failed to extract download URL from API response")
+        
+        # Create a temporary directory to store the downloaded files
+        with tempfile.TemporaryDirectory() as temp_dir:
+            # Download the zip file
+            zip_path = os.path.join(temp_dir, "pio_terminals.zip")
+            if verbose:
+                print("Downloading zip file")
+            
+            response = requests.get(download_url, stream=True)
+            response.raise_for_status()
+            
+            with open(zip_path, 'wb') as f:
+                response.raw.decode_content = True
+                shutil.copyfileobj(response.raw, f)
+            
+            # Extract the zip file
+            if verbose:
+                print("Extracting files")
+            
+            with zipfile.ZipFile(zip_path, 'r') as zip_ref:
+                zip_ref.extractall(temp_dir)
+            
+            # Find the shapefile in the extracted files
+            shp_files = [f for f in os.listdir(temp_dir) if f.endswith('.shp')]
+            
+            if not shp_files:
+                raise Exception("No shapefile found in the downloaded zip file")
+            
+            # Read the shapefile
+            if verbose:
+                print("Reading shapefile")
+            
+            shp_path = os.path.join(temp_dir, shp_files[0])
+            gdf = gpd.read_file(shp_path)
+            
+            # Convert to SIRGAS 2000 (EPSG:4674)
+            if verbose:
+                print("Converting to SIRGAS 2000 (EPSG:4674)")
+            
+            gdf = gdf.to_crs(epsg=4674)
+            
+            # Simplify the dataset if requested
+            if simplified:
+                if verbose:
+                    print("Simplifying the dataset")
+                
+                # Select only the most important columns
+                # Adjust these columns based on the actual data structure
+                cols_to_keep = ['NOME', 'EMPRESA', 'TIPO', 'CAPACIDADE', 'UF', 'MUNICIPIO', 'geometry']
+                cols_available = [col for col in cols_to_keep if col in gdf.columns]
+                
+                if not cols_available:
+                    warnings.warn("None of the specified columns for simplification are available. Returning the full dataset.")
+                else:
+                    gdf = gdf[cols_available]
+            
+            if verbose:
+                print("Finished processing PIO terminals data")
+            
+            return gdf
+    
+    except Exception as e:
+        raise Exception(f"Failed to download or process PIO terminals data: {str(e)}")