maps4fs 1.7.5__py3-none-any.whl → 1.7.7__py3-none-any.whl

maps4fs/__init__.py

@@ -3,6 +3,7 @@ from maps4fs.generator.dtm.dtm import DTMProvider
 from maps4fs.generator.dtm.srtm import SRTM30Provider, SRTM30ProviderSettings
 from maps4fs.generator.dtm.usgs import USGSProvider, USGSProviderSettings
 from maps4fs.generator.dtm.nrw import NRWProvider, NRWProviderSettings
+from maps4fs.generator.dtm.bavaria import BavariaProvider, BavariaProviderSettings
 from maps4fs.generator.game import Game
 from maps4fs.generator.map import Map
 from maps4fs.generator.settings import (

maps4fs/generator/dtm/bavaria.py

@@ -0,0 +1,115 @@
+"""This module contains provider of Bavaria data."""
+
+import os
+
+from xml.etree import ElementTree as ET
+import hashlib
+import numpy as np
+import requests
+from maps4fs.generator.dtm.dtm import DTMProvider, DTMProviderSettings
+
+class BavariaProviderSettings(DTMProviderSettings):
+    """Settings for the Bavaria provider."""
+
+
+class BavariaProvider(DTMProvider):
+    """Provider of Bavaria Digital terrain model (DTM) 1m data.
+    Data is provided by the 'Bayerische Vermessungsverwaltung' and available
+    at https://geodaten.bayern.de/opengeodata/OpenDataDetail.html?pn=dgm1 under CC BY 4.0 license.
+    """
+
+    _code = "bavaria"
+    _name = "Bavaria DGM1"
+    _region = "DE"
+    _icon = "🇩🇪󠁥󠁢󠁹󠁿"
+    _resolution = 1
+    _data: np.ndarray | None = None
+    _settings = BavariaProviderSettings
+    _author = "[H4rdB4se](https://github.com/H4rdB4se)"
+    _is_community = True
+    _instructions = None
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.tiff_path = os.path.join(self._tile_directory, "tiffs")
+        os.makedirs(self.tiff_path, exist_ok=True)
+        self.meta4_path = os.path.join(self._tile_directory, "meta4")
+        os.makedirs(self.meta4_path, exist_ok=True)
+
+    def download_tiles(self) -> list[str]:
+        download_urls = self.get_meta_file_from_coords()
+        all_tif_files = self.download_tif_files(download_urls, self.tiff_path)
+        return all_tif_files
+
+    @staticmethod
+    def get_meta_file_name(north: float, south: float, east: float, west: float) -> str:
+        """Generate a hashed file name for the .meta4 file.
+
+        Arguments:
+            north (float): Northern latitude.
+            south (float): Southern latitude.
+            east (float): Eastern longitude.
+            west (float): Western longitude.
+
+        Returns:
+            str: Hashed file name.
+        """
+        coordinates = f"{north}_{south}_{east}_{west}"
+        hash_object = hashlib.md5(coordinates.encode())
+        hashed_file_name = "download_" + hash_object.hexdigest() + ".meta4"
+        return hashed_file_name
+
+    def get_meta_file_from_coords(self) -> list[str]:
+        """Download .meta4 (xml format) file
+
+        Returns:
+            list: List of download URLs.
+        """
+        (north, south, east, west) = self.get_bbox()
+        file_path = os.path.join(self.meta4_path, self.get_meta_file_name(north, south, east, west))
+        if not os.path.exists(file_path):
+            try:
+                # Make the GET request
+                response = requests.post(
+                    "https://geoservices.bayern.de/services/poly2metalink/metalink/dgm1",
+                    (f"SRID=4326;POLYGON(({west} {south},{east} {south},"
+                     f"{east} {north},{west} {north},{west} {south}))"),
+                    stream=True,
+                    timeout=60
+                )
+
+                # Check if the request was successful (HTTP status code 200)
+                if response.status_code == 200:
+                    # Write the content of the response to the file
+                    with open(file_path, "wb") as meta_file:
+                        for chunk in response.iter_content(chunk_size=8192):  # Download in chunks
+                            meta_file.write(chunk)
+                    self.logger.info("File downloaded successfully: %s", file_path)
+                else:
+                    self.logger.error("Download error. HTTP Status Code: %s", response.status_code)
+            except requests.exceptions.RequestException as e:
+                self.logger.error("Failed to get data. Error: %s", e)
+        else:
+            self.logger.debug("File already exists: %s", file_path)
+        return self.extract_urls_from_xml(file_path)
+
+    def extract_urls_from_xml(self, file_path: str) -> list[str]:
+        """Extract URLs from the XML file.
+
+        Arguments:
+            file_path (str): Path to the XML file.
+
+        Returns:
+            list: List of URLs.
+        """
+        urls: list[str] = []
+        root = ET.parse(file_path).getroot()
+        namespace = {'ml': 'urn:ietf:params:xml:ns:metalink'}
+
+        for file in root.findall('.//ml:file', namespace):
+            url = file.find('ml:url', namespace)
+            if url is not None:
+                urls.append(str(url.text))
+
+        self.logger.debug("Received %s urls", len(urls))
+        return urls

maps4fs/generator/dtm/dtm.py

@@ -7,10 +7,12 @@ from __future__ import annotations
 from abc import ABC, abstractmethod
 import os
 from typing import TYPE_CHECKING, Type
+from zipfile import ZipFile
 
 import numpy as np
 import osmnx as ox  # type: ignore
 import rasterio  # type: ignore
+import requests
 from rasterio.warp import calculate_default_transform, reproject
 from rasterio.enums import Resampling
 from rasterio.merge import merge
@@ -300,7 +302,7 @@ class DTMProvider(ABC):
         self.data_info = {}
         self.add_numpy_params(data, "original")
 
-        data = self.signed_to_unsigned(data)
+        data = self.ground_height_data(data)
         self.add_numpy_params(data, "grounded")
 
         original_deviation = int(self.data_info["original_deviation"])
@@ -339,7 +341,7 @@ class DTMProvider(ABC):
                     "Failed to normalize DEM data. Error: %s. Using original data.", e
                 )
 
-        return data
+        return data.astype(np.uint16)
 
     def info_sequence(self) -> dict[str, int | str | float] | None:
         """Returns the information sequence for the component. Must be implemented in the child
@@ -364,20 +366,75 @@ class DTMProvider(ABC):
         bbox = north, south, east, west
         return bbox
 
+    def download_tif_files(self, urls: list[str], output_path: str) -> list[str]:
+        """Download GeoTIFF files from the given URLs.
+
+        Arguments:
+            urls (list): List of URLs to download GeoTIFF files from.
+            output_path (str): Path to save the downloaded GeoTIFF files.
+
+        Returns:
+            list: List of paths to the downloaded GeoTIFF files.
+        """
+        tif_files: list[str] = []
+        for url in urls:
+            file_name = os.path.basename(url)
+            self.logger.debug("Retrieving TIFF: %s", file_name)
+            file_path = os.path.join(output_path, file_name)
+            if not os.path.exists(file_path):
+                try:
+                    # Send a GET request to the file URL
+                    response = requests.get(url, stream=True, timeout=60)
+                    response.raise_for_status()  # Raise an error for HTTP status codes 4xx/5xx
+
+                    # Write the content of the response to the file
+                    with open(file_path, "wb") as file:
+                        for chunk in response.iter_content(chunk_size=8192):  # Download in chunks
+                            file.write(chunk)
+                    self.logger.info("File downloaded successfully: %s", file_path)
+                except requests.exceptions.RequestException as e:
+                    self.logger.error("Failed to download file: %s", e)
+            else:
+                self.logger.debug("File already exists: %s", file_name)
+            if file_name.endswith('.zip'):
+                file_path = self.unzip_img_from_tif(file_name, output_path)
+            tif_files.append(file_path)
+        return tif_files
+
+    def unzip_img_from_tif(self, file_name: str, output_path: str) -> str:
+        """Unpacks the .img file from the zip file.
+
+        Arguments:
+            file_name (str): Name of the file to unzip.
+            output_path (str): Path to the output directory.
+
+        Returns:
+            str: Path to the unzipped file.
+        """
+        file_path = os.path.join(output_path, file_name)
+        img_file_name = file_name.replace('.zip', '.img')
+        img_file_path = os.path.join(output_path, img_file_name)
+        if not os.path.exists(img_file_path):
+            with ZipFile(file_path, "r") as f_in:
+                f_in.extract(img_file_name, output_path)
+            self.logger.debug("Unzipped file %s to %s", file_name, img_file_name)
+        else:
+            self.logger.debug("File already exists: %s", img_file_name)
+        return img_file_path
+
     def reproject_geotiff(self, input_tiff: str) -> str:
         """Reproject a GeoTIFF file to a new coordinate reference system (CRS).
 
         Arguments:
             input_tiff (str): Path to the input GeoTIFF file.
-            target_crs (str): Target CRS (e.g., EPSG:4326 for CRS:84).
 
         Returns:
             str: Path to the reprojected GeoTIFF file.
         """
-        output_tiff = os.path.join(self._tile_directory, "merged.tif")
+        output_tiff = os.path.join(self._tile_directory, "reprojected.tif")
 
         # Open the source GeoTIFF
-        self.logger.debug("Reprojecting GeoTIFF to %s CRS...", "EPSG:4326")
+        self.logger.debug("Reprojecting GeoTIFF to EPSG:4326 CRS...")
         with rasterio.open(input_tiff) as src:
             # Get the transform, width, and height of the target CRS
             transform, width, height = calculate_default_transform(
@@ -411,7 +468,6 @@ class DTMProvider(ABC):
 
         Arguments:
             input_files (list): List of input GeoTIFF files to merge.
-            output_file (str): Path to save the merged GeoTIFF file.
         """
         output_file = os.path.join(self._tile_directory, "merged.tif")
         # Open all input GeoTIFF files as datasets
@@ -516,11 +572,15 @@ class DTMProvider(ABC):
         )
         return normalized_data
 
-    def signed_to_unsigned(self, data: np.ndarray, add_one: bool = True) -> np.ndarray:
-        """Convert signed 16-bit integer to unsigned 16-bit integer.
+    @staticmethod
+    def ground_height_data(data: np.ndarray, add_one: bool = True) -> np.ndarray:
+        """Shift the data to ground level (0 meter).
+        Optionally add one meter to the data to leave some room
+        for the water level and pit modifications.
 
         Arguments:
-            data (np.ndarray): DEM data from SRTM file after cropping.
+            data (np.ndarray): DEM data after cropping.
+            add_one (bool): Add one meter to the data
 
         Returns:
             np.ndarray: Unsigned DEM data.
@@ -528,7 +588,7 @@ class DTMProvider(ABC):
         data = data - data.min()
         if add_one:
             data = data + 1
-        return data.astype(np.uint16)
+        return data
 
     def add_numpy_params(
         self,

maps4fs/generator/dtm/nrw.py

@@ -1,4 +1,4 @@
-"""This module contains provider of USGS data."""
+"""This module contains provider of NRW data."""
 
 import os
 
@@ -11,7 +11,7 @@ from maps4fs.generator.dtm.dtm import DTMProvider, DTMProviderSettings
 
 
 class NRWProviderSettings(DTMProviderSettings):
-    """Settings for the USGS provider."""
+    """Settings for the NRW provider."""
 
 
 # pylint: disable=too-many-locals

maps4fs/generator/dtm/usgs.py

@@ -2,7 +2,6 @@
 
 import os
 from datetime import datetime
-from zipfile import ZipFile
 
 import numpy as np
 import requests
@@ -46,7 +45,7 @@ class USGSProvider(DTMProvider):
 
     def download_tiles(self):
         download_urls = self.get_download_urls()
-        all_tif_files = self.download_tif_files(download_urls)
+        all_tif_files = self.download_tif_files(download_urls, self.shared_tiff_path)
         return all_tif_files
 
     def __init__(self, *args, **kwargs):
@@ -88,48 +87,3 @@ class USGSProvider(DTMProvider):
             self.logger.error("Failed to get data. Error: %s", e)
         self.logger.debug("Received %s urls", len(urls))
         return urls
-
-    def download_tif_files(self, urls: list[str]) -> list[str]:
-        """Download GeoTIFF files from the given URLs.
-
-        Arguments:
-            urls (list): List of URLs to download GeoTIFF files from.
-
-        Returns:
-            list: List of paths to the downloaded GeoTIFF files.
-        """
-        tif_files = []
-        for url in urls:
-            file_name = os.path.basename(url)
-            self.logger.debug("Retrieving TIFF: %s", file_name)
-            file_path = os.path.join(self.shared_tiff_path, file_name)
-            if not os.path.exists(file_path):
-                try:
-                    # Send a GET request to the file URL
-                    response = requests.get(url, stream=True)  # pylint: disable=W3101
-                    response.raise_for_status()  # Raise an error for HTTP status codes 4xx/5xx
-
-                    # Write the content of the response to the file
-                    with open(file_path, "wb") as file:
-                        for chunk in response.iter_content(chunk_size=8192):  # Download in chunks
-                            file.write(chunk)
-                    self.logger.info("File downloaded successfully: %s", file_path)
-                    if file_name.endswith('.zip'):
-                        with ZipFile(file_path, "r") as f_in:
-                            f_in.extract(file_name.replace('.zip', '.img'), self.shared_tiff_path)
-                        tif_files.append(file_path.replace('.zip', '.img'))
-                    else:
-                        tif_files.append(file_path)
-                except requests.exceptions.RequestException as e:
-                    self.logger.error("Failed to download file: %s", e)
-            else:
-                self.logger.debug("File already exists: %s", file_name)
-                if file_name.endswith('.zip'):
-                    if not os.path.exists(file_path.replace('.zip', '.img')):
-                        with ZipFile(file_path, "r") as f_in:
-                            f_in.extract(file_name.replace('.zip', '.img'), self.shared_tiff_path)
-                    tif_files.append(file_path.replace('.zip', '.img'))
-                else:
-                    tif_files.append(file_path)
-
-        return tif_files

maps4fs/generator/game.py

@@ -58,18 +58,19 @@ class Game:
         return os.path.join(map_directory, "maps", "map", "map.xml")
 
     @classmethod
-    def from_code(cls, code: str) -> Game:
+    def from_code(cls, code: str, map_template_path: str | None = None) -> Game:
         """Returns the game instance based on the game code.
 
         Arguments:
             code (str): The code of the game.
+            map_template_path (str, optional): Path to the map template file. Defaults to None.
 
         Returns:
             Game: The game instance.
         """
         for game in cls.__subclasses__():
             if game.code and game.code.lower() == code.lower():
-                return game()
+                return game(map_template_path)
         raise ValueError(f"Game with code {code} not found.")
 
     @property

{maps4fs-1.7.5.dist-info → maps4fs-1.7.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: maps4fs
-Version: 1.7.5
+Version: 1.7.7
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License

{maps4fs-1.7.5.dist-info → maps4fs-1.7.7.dist-info}/RECORD

@@ -1,11 +1,11 @@
-maps4fs/__init__.py,sha256=TXqX7Ks_Kqt2fiXRt5zdVSLUHxP4cT_p7jgutYFdbo8,630
+maps4fs/__init__.py,sha256=I-WDbZBb1l6us3QxDajPGzjVJe9PK0QrE5DqZwSsd_w,713
 maps4fs/logger.py,sha256=B-NEYpMjPAAqlV4VpfTi6nbBFnEABVtQOaYe6nMpidg,1489
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
 maps4fs/generator/background.py,sha256=tV4UXvtkNN-OSvv6ujp4jFWRU1xGBgEvSakVGZ1H4nc,24877
 maps4fs/generator/component.py,sha256=pbpGaWy5C0UzxpcJ72HPY2gMol98snDr-bvNZSX4yY0,20823
 maps4fs/generator/config.py,sha256=0QmK052B8bxyHVhg3jzCORLfOBMMmqVfhhbqXKf6OMk,4383
 maps4fs/generator/dem.py,sha256=20gx0dzX0LyO6ipvDitst-BwGfcKogFqgQf9Q2qMH5U,10933
-maps4fs/generator/game.py,sha256=Nf5r2ubV4YVAVHGzJyhbF2GnOC0qV3HlHYIZBCWciHs,7992
+maps4fs/generator/game.py,sha256=GmCl_KQ9D-UwKao4HFEb0PRAm829ThtSZfkgzK3Oh2g,8143
 maps4fs/generator/grle.py,sha256=hcbVBJ4j_Zr2QvEVo2cYNh2jARVXp_X3onifBtp9Zxs,20922
 maps4fs/generator/i3d.py,sha256=pUyHKWKcw43xVCf3Y8iabtbQba05LYxMHi8vziGksIA,24843
 maps4fs/generator/map.py,sha256=a50KQEr1XZKjS_WKXywGwh4OC3gyjY6M8FTc0eNcxpg,10183
@@ -14,16 +14,17 @@ maps4fs/generator/satellite.py,sha256=_7RcuNmR1mjxEJWMDsjnzKUIqWxnGUn50XtjB7HmSP
 maps4fs/generator/settings.py,sha256=9vbXISQrE-aDY7ATpvZ7LVJMqjfwa3-gNl-huI8XLO0,5666
 maps4fs/generator/texture.py,sha256=L_j5GTTJXbp7OCT4-TWGFcY_zyAI_fNzDFLvXYiyKPI,33921
 maps4fs/generator/dtm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-maps4fs/generator/dtm/dtm.py,sha256=T2h7eP5kQEWTGllI8ZxcGCDW4czZSoPBgOUS8a7_Ym8,19105
-maps4fs/generator/dtm/nrw.py,sha256=lJYZBZB4n5egUlX2iA7AhLmMIRKB7i_LVxCTohWsSmw,4612
+maps4fs/generator/dtm/bavaria.py,sha256=r6-3DcKY4JeFQ-8jbf0xxtB5SPbbZc7KSGYxllqOCo4,4412
+maps4fs/generator/dtm/dtm.py,sha256=DXRxpRuzy5l00yGVMkxamJE2zRygwpi6xcEe29y7LsA,21714
+maps4fs/generator/dtm/nrw.py,sha256=8h33743_FvfScnABSFWgV7zPE5L1i6vL2uwpIMZey6g,4610
 maps4fs/generator/dtm/srtm.py,sha256=RsvVa7ErajPwXoetG7mO_rldji9GR97HFaazH-PkdHw,4399
-maps4fs/generator/dtm/usgs.py,sha256=fWFR_kO_uLVjAJAL43YFvBaHwsXWI-00jMlp23Ue7Wo,5450
+maps4fs/generator/dtm/usgs.py,sha256=dyy2NT0USlRkYL2qfXQzFT_q3VfkVZUSmKBzPkDNvV4,3202
 maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
 maps4fs/toolbox/background.py,sha256=9BXWNqs_n3HgqDiPztWylgYk_QM4YgBpe6_ZNQAWtSc,2154
 maps4fs/toolbox/custom_osm.py,sha256=X6ZlPqiOhNjkmdD_qVroIfdOl9Rb90cDwVSLDVYgx80,1892
 maps4fs/toolbox/dem.py,sha256=z9IPFNmYbjiigb3t02ZenI3Mo8odd19c5MZbjDEovTo,3525
-maps4fs-1.7.5.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-1.7.5.dist-info/METADATA,sha256=ZccKMQWPuC1-c3PWO7MZUG52LwxsrnP9_cOZ4jeTza0,40436
-maps4fs-1.7.5.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-maps4fs-1.7.5.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-1.7.5.dist-info/RECORD,,
+maps4fs-1.7.7.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-1.7.7.dist-info/METADATA,sha256=rf4b6SCuVflM7i2t3N2FrGKvgJJetsnKIhMroi5kq0k,40436
+maps4fs-1.7.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+maps4fs-1.7.7.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-1.7.7.dist-info/RECORD,,