maps4fs 1.7.1__tar.gz → 1.7.2__tar.gz

{maps4fs-1.7.1 → maps4fs-1.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: maps4fs
-Version: 1.7.1
+Version: 1.7.2
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -141,7 +141,7 @@ Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
 ```bash
 pip install maps4fs
 ```
-And refer to the [Python package](#option-3-python-package) section to learn how to use it.<br>
+And refer to the [Python package or run from the source](#option-3-python-package-or-source-code) section to learn how to use it.<br>
 
 ## Overview
 The core idea is coming from the awesome [maps4cim](https://github.com/klamann/maps4cim) project.<br>
@@ -201,7 +201,7 @@ docker run -d -p 8501:8501 --name maps4fs iwatkot/maps4fs
 4. Fill in the required fields and click on the `Generate` button.
 5. When the map is generated click on the `Download` button to get the map.
 
-### Option 3: Python package
+### Option 3: Python package or source code
 🔴 Recommended for developers.  
 🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
 ⚙️ Advanced settings: enabled.   
@@ -212,11 +212,50 @@ You can use the Python package to generate maps. Follow these steps:
 ```bash
 pip install maps4fs
 ```
+
+Or clone the repository and install the package from the source code:
+```bash
+git clone https://github.com/iwatkot/maps4fs.git
+cd maps4fs
+dev/create_venv.ps1 # for Windows
+sh dev/create_venv.sh # for Linux
+
+# Activate the virtual environment.
+./venv/scripts/activate # for Windows
+source venv/bin/activate # for Linux
+
+# Edit the demo.py file to set the parameters.
+python demo.py
+```
+
+
 2. Import the Game class and create an instance of it:
 ```python
 import maps4fs as mfs
 
-game = mfs.Game.from_code("FS25")
+game_code = "fs25"
+game = mfs.Game.from_code(game_code)
+
+dtm_provider = mfs.SRTM30Provider
+dtm_provider_settings = mfs.SRTM30ProviderSettings(easy_mode=True, power_factor=0)
+
+lat, lon = 45.28, 20.23
+coordinates = (lat, lon)
+size = 2048
+rotation = 25
+
+map_directory = "map_directory"
+os.makedirs(map_directory, exist_ok=True)
+
+mp = mfs.Map(
+    game,
+    dtm_provider,
+    dtm_provider_settings,
+    coordinates,
+    size,
+    rotation,
+    map_directory,
+)
 ```
 In this case, the library will use the default templates, which should be present in the `data` directory, which should be placed in the current working directory.<br>
 Structure example:<br>
@@ -229,28 +268,17 @@ Structure example:<br>
 
 So it's recommended to download the `data` directory from the repository and place it in the root of your project.<br>
 
-3. Create an instance of the Map class:
-```python
-import maps4fs as mfs
-
-map = mfs.Map(
-  game,
-  (52.5200, 13.4050),  # Latitude and longitude of the map center.
-  height=1024,  # The height of the map in meters.
-  width=1024,  # The width of the map in meters.
-  map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
-)
-```
-
-4. Generate the map:
+3. Launch the generation process.  
 The `generate` method returns a generator, which yields the active component of the map. You can use it to track the progress of the generation process.
 ```python
-for active_component in map.generate():
-    print(active_component)
+for component_name in mp.generate():
+    print(f"Generating {component_name}...")
 ```
 
 The map will be saved in the `map_directory` directory.
 
+➡️ Check out the [demo.py](demo.py) file for a complete example.
+
 ## Modder Toolbox
 The tool now has a Modder Toolbox, which is a set of tools to help you with various tasks. You can open the toolbox by switching to the `🧰 Modder Toolbox` tab in the StreamLit app.<br>
 

{maps4fs-1.7.1 → maps4fs-1.7.2}/README.md

@@ -115,7 +115,7 @@ Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
 ```bash
 pip install maps4fs
 ```
-And refer to the [Python package](#option-3-python-package) section to learn how to use it.<br>
+And refer to the [Python package or run from the source](#option-3-python-package-or-source-code) section to learn how to use it.<br>
 
 ## Overview
 The core idea is coming from the awesome [maps4cim](https://github.com/klamann/maps4cim) project.<br>
@@ -175,7 +175,7 @@ docker run -d -p 8501:8501 --name maps4fs iwatkot/maps4fs
 4. Fill in the required fields and click on the `Generate` button.
 5. When the map is generated click on the `Download` button to get the map.
 
-### Option 3: Python package
+### Option 3: Python package or source code
 🔴 Recommended for developers.  
 🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
 ⚙️ Advanced settings: enabled.   
@@ -186,11 +186,50 @@ You can use the Python package to generate maps. Follow these steps:
 ```bash
 pip install maps4fs
 ```
+
+Or clone the repository and install the package from the source code:
+```bash
+git clone https://github.com/iwatkot/maps4fs.git
+cd maps4fs
+dev/create_venv.ps1 # for Windows
+sh dev/create_venv.sh # for Linux
+
+# Activate the virtual environment.
+./venv/scripts/activate # for Windows
+source venv/bin/activate # for Linux
+
+# Edit the demo.py file to set the parameters.
+python demo.py
+```
+
+
 2. Import the Game class and create an instance of it:
 ```python
 import maps4fs as mfs
 
-game = mfs.Game.from_code("FS25")
+game_code = "fs25"
+game = mfs.Game.from_code(game_code)
+
+dtm_provider = mfs.SRTM30Provider
+dtm_provider_settings = mfs.SRTM30ProviderSettings(easy_mode=True, power_factor=0)
+
+lat, lon = 45.28, 20.23
+coordinates = (lat, lon)
+size = 2048
+rotation = 25
+
+map_directory = "map_directory"
+os.makedirs(map_directory, exist_ok=True)
+
+mp = mfs.Map(
+    game,
+    dtm_provider,
+    dtm_provider_settings,
+    coordinates,
+    size,
+    rotation,
+    map_directory,
+)
 ```
 In this case, the library will use the default templates, which should be present in the `data` directory, which should be placed in the current working directory.<br>
 Structure example:<br>
@@ -203,28 +242,17 @@ Structure example:<br>
 
 So it's recommended to download the `data` directory from the repository and place it in the root of your project.<br>
 
-3. Create an instance of the Map class:
-```python
-import maps4fs as mfs
-
-map = mfs.Map(
-  game,
-  (52.5200, 13.4050),  # Latitude and longitude of the map center.
-  height=1024,  # The height of the map in meters.
-  width=1024,  # The width of the map in meters.
-  map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
-)
-```
-
-4. Generate the map:
+3. Launch the generation process.  
 The `generate` method returns a generator, which yields the active component of the map. You can use it to track the progress of the generation process.
 ```python
-for active_component in map.generate():
-    print(active_component)
+for component_name in mp.generate():
+    print(f"Generating {component_name}...")
 ```
 
 The map will be saved in the `map_directory` directory.
 
+➡️ Check out the [demo.py](demo.py) file for a complete example.
+
 ## Modder Toolbox
 The tool now has a Modder Toolbox, which is a set of tools to help you with various tasks. You can open the toolbox by switching to the `🧰 Modder Toolbox` tab in the StreamLit app.<br>
 

{maps4fs-1.7.1 → maps4fs-1.7.2}/maps4fs/__init__.py

@@ -1,7 +1,7 @@
 # pylint: disable=missing-module-docstring
 from maps4fs.generator.dtm.dtm import DTMProvider
-from maps4fs.generator.dtm.srtm import SRTM30Provider
-from maps4fs.generator.dtm.usgs import USGSProvider
+from maps4fs.generator.dtm.srtm import SRTM30Provider, SRTM30ProviderSettings
+from maps4fs.generator.dtm.usgs import USGSProvider, USGSProviderSettings
 from maps4fs.generator.game import Game
 from maps4fs.generator.map import Map
 from maps4fs.generator.settings import (
@@ -9,6 +9,7 @@ from maps4fs.generator.settings import (
     DEMSettings,
     GRLESettings,
     I3DSettings,
+    SatelliteSettings,
     SettingsModel,
     SplineSettings,
     TextureSettings,

{maps4fs-1.7.1 → maps4fs-1.7.2}/maps4fs/generator/texture.py

@@ -466,7 +466,11 @@ class Texture(Component):
                         self.np_to_polygon_points(polygon)  # type: ignore
                     )
                 if not layer.invisible:
-                    cv2.fillPoly(layer_image, [polygon], color=255)  # type: ignore
+                    try:
+                        cv2.fillPoly(layer_image, [polygon], color=255)  # type: ignore
+                    except Exception as e:  # pylint: disable=W0718
+                        self.logger.warning("Error drawing polygon: %s.", repr(e))
+                        continue
 
             if layer.info_layer == "roads":
                 for linestring in self.objects_generator(

{maps4fs-1.7.1 → maps4fs-1.7.2}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: maps4fs
-Version: 1.7.1
+Version: 1.7.2
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -141,7 +141,7 @@ Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
 ```bash
 pip install maps4fs
 ```
-And refer to the [Python package](#option-3-python-package) section to learn how to use it.<br>
+And refer to the [Python package or run from the source](#option-3-python-package-or-source-code) section to learn how to use it.<br>
 
 ## Overview
 The core idea is coming from the awesome [maps4cim](https://github.com/klamann/maps4cim) project.<br>
@@ -201,7 +201,7 @@ docker run -d -p 8501:8501 --name maps4fs iwatkot/maps4fs
 4. Fill in the required fields and click on the `Generate` button.
 5. When the map is generated click on the `Download` button to get the map.
 
-### Option 3: Python package
+### Option 3: Python package or source code
 🔴 Recommended for developers.  
 🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
 ⚙️ Advanced settings: enabled.   
@@ -212,11 +212,50 @@ You can use the Python package to generate maps. Follow these steps:
 ```bash
 pip install maps4fs
 ```
+
+Or clone the repository and install the package from the source code:
+```bash
+git clone https://github.com/iwatkot/maps4fs.git
+cd maps4fs
+dev/create_venv.ps1 # for Windows
+sh dev/create_venv.sh # for Linux
+
+# Activate the virtual environment.
+./venv/scripts/activate # for Windows
+source venv/bin/activate # for Linux
+
+# Edit the demo.py file to set the parameters.
+python demo.py
+```
+
+
 2. Import the Game class and create an instance of it:
 ```python
 import maps4fs as mfs
 
-game = mfs.Game.from_code("FS25")
+game_code = "fs25"
+game = mfs.Game.from_code(game_code)
+
+dtm_provider = mfs.SRTM30Provider
+dtm_provider_settings = mfs.SRTM30ProviderSettings(easy_mode=True, power_factor=0)
+
+lat, lon = 45.28, 20.23
+coordinates = (lat, lon)
+size = 2048
+rotation = 25
+
+map_directory = "map_directory"
+os.makedirs(map_directory, exist_ok=True)
+
+mp = mfs.Map(
+    game,
+    dtm_provider,
+    dtm_provider_settings,
+    coordinates,
+    size,
+    rotation,
+    map_directory,
+)
 ```
 In this case, the library will use the default templates, which should be present in the `data` directory, which should be placed in the current working directory.<br>
 Structure example:<br>
@@ -229,28 +268,17 @@ Structure example:<br>
 
 So it's recommended to download the `data` directory from the repository and place it in the root of your project.<br>
 
-3. Create an instance of the Map class:
-```python
-import maps4fs as mfs
-
-map = mfs.Map(
-  game,
-  (52.5200, 13.4050),  # Latitude and longitude of the map center.
-  height=1024,  # The height of the map in meters.
-  width=1024,  # The width of the map in meters.
-  map_directory="path/to/your/map/directory",  # The directory where the map will be saved.
-)
-```
-
-4. Generate the map:
+3. Launch the generation process.  
 The `generate` method returns a generator, which yields the active component of the map. You can use it to track the progress of the generation process.
 ```python
-for active_component in map.generate():
-    print(active_component)
+for component_name in mp.generate():
+    print(f"Generating {component_name}...")
 ```
 
 The map will be saved in the `map_directory` directory.
 
+➡️ Check out the [demo.py](demo.py) file for a complete example.
+
 ## Modder Toolbox
 The tool now has a Modder Toolbox, which is a set of tools to help you with various tasks. You can open the toolbox by switching to the `🧰 Modder Toolbox` tab in the StreamLit app.<br>
 

{maps4fs-1.7.1 → maps4fs-1.7.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maps4fs"
-version = "1.7.1"
+version = "1.7.2"
 description = "Generate map templates for Farming Simulator from real places."
 authors = [{name = "iwatkot", email = "iwatkot@gmail.com"}]
 license = {text = "MIT License"}