maps4fs 2.2.71__tar.gz → 2.2.73__tar.gz

{maps4fs-2.2.71 → maps4fs-2.2.73}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 2.2.71
+Version: 2.2.73
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: Apache License 2.0
@@ -18,15 +18,13 @@ Requires-Dist: osmnx>=2.0.0
 Requires-Dist: rasterio
 Requires-Dist: geopy
 Requires-Dist: trimesh
-Requires-Dist: imageio
-Requires-Dist: tifffile
-Requires-Dist: pympler
 Requires-Dist: pydantic
 Requires-Dist: pygmdl
 Requires-Dist: owslib
 Requires-Dist: tqdm
 Requires-Dist: scipy
 Requires-Dist: pydtmdl
+Requires-Dist: manifold3d
 Dynamic: license-file
 
 ⚠️ Learn more about the 2.0 changes in the [migration guide](docs/migration.md).  
@@ -54,7 +52,6 @@ Dynamic: license-file
   <a href="#Overview">Overview</a> • 
   <a href="docs/step_by_step.md">Create a map in 10 steps</a> •
   <a href="docs/recommendations.md">Practical recommendations</a> •
-  <a href="#How-To-Run">How-To-Run</a><br>
   <a href="docs/my_maps.md">My Maps</a> •
   <a href="docs/FAQ.md">FAQ</a> •
   <a href="docs/map_structure.md">Map Structure</a> •
@@ -151,38 +148,49 @@ There are several ways to use the tool. You obviously need the **first one**, bu
 ### 🚜 For most users
 
 **Option 1:** Open the [maps4fs](https://maps4fs.xyz) and generate a map template in a few clicks.<br>
+🟢 Recommended for all users.  
+🛠️ Don't need to install anything.  
+🗺️ Supported map sizes: 2x2, 4x4, custom sizes not available.  
+✂️ Map scaling: not supported.  
+⚙️ Advanced settings: some settings not available.  
 
 ![Basic WebUI](https://github.com/iwatkot/maps4fs/releases/download/2.0.0/maps4fs_wui.png)
 
 ### 😎 For advanced users
 
-**Option 2:** Run the Docker version in your browser. Launch the following command in your terminal:
-
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs iwatkot/maps4fs
-```
+**Option 2:** Run the Docker version in your browser.  
+🟠 Recommended for users who want bigger maps, fast generation, nice-looking textures, and advanced settings.  
+🛠️ Docker installation required, launch with one command.  
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+✂️ Map scaling: supported.  
+⚙️ Advanced settings: all settings available.
 
-If you want to persist your data, you can mount a directory to the container: 
+Launch the following command in your terminal to use the Setup Wizard:
 
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs -v /c/maps4fs:/usr/src/app/mfsrootdir iwatkot/maps4fs
+```powershell
+powershell -ExecutionPolicy Bypass -Command "iex (iwr 'https://raw.githubusercontent.com/iwatkot/maps4fs/main/setup-wizard.ps1' -UseBasicParsing).Content"
 ```
 
-Learn more in the [My Maps](docs/my_maps.md) documentation.
+ℹ️ Check out detailed instructions about [local deployment](docs/local_deployment.md).
 
-And open [http://localhost:8501](http://localhost:8501) in your browser.<br>
-If you don't know how to use Docker, navigate to the [Docker version](#option-2-docker-version), it's really simple.<br>
-Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
 
 ### 🤯 For developers
 
-**Option 3:** Python package. Install the package using the following command:
+**Option 3:** Python package or run from source code.
+🔴 Recommended for developers who want full control over the generation process and fastest performance.
+🛠️ Requires Python, pip, and Git.
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+✂️ Map scaling: supported.  
+⚙️ Advanced settings: all settings available.
+
+Install the package using the following command:
 
 ```bash
 pip install maps4fs
 ```
 
-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>
+ℹ️ Check out detailed instructions about [Maps4FS Python Package Deployment](docs/local_deployment_source.md).
+
 
 ## Overview
 
@@ -216,134 +224,6 @@ Parameters:
 
 Don't know where to start? Don't worry, just follow this [step-by-step guide](docs/step_by_step.md) to create your first map in 10 simple steps.<br>
 
-## How-To-Run
-
-### Option 1: Public version
-
-🟢 Recommended for all users.  
-🛠️ Don't need to install anything.  
-🗺️ Supported map sizes: 2x2, 4x4.  
-✂️ Map scaling: not supported.  
-⚙️ Advanced settings: partial.  
-🖼️ Texture dissolving: disabled.  
-Using the public version on [maps4fs.xyz](https://maps4fs.xyz) is the easiest way to generate a map template. Just open the link and follow the instructions.
-Note: due to CPU and RAM limitations of the hosting, the generation may take some time. If you need faster processing, use the [Docker version](#option-2-docker-version).<br>
-
-Using it is easy and doesn't require any guides. Enjoy!
-
-### Option 2: Docker version
-
-🟠 Recommended for users who want bigger maps, fast generation, nice-looking textures, and advanced settings.  
-🛠️ Launch with one single command.  
-🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
-✂️ Map scaling: supported.  
-⚙️ Advanced settings: enabled.  
-🖼️ Texture dissolving: enabled.  
-Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
-
-📹 Check out the [video tutorial](https://www.youtube.com/watch?v=1AHGIxTxSBM) on how to install Docker and use the Docker version.  
-
-You can launch the project with minimalistic UI in your browser using Docker. Follow these steps:
-
-1. Install [Docker](https://docs.docker.com/get-docker/) for your OS.
-2. Run the following command in your terminal:
-
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs iwatkot/maps4fs
-```
-
-If you want to persist your data, you can mount a directory to the container:
-
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs -v /c/maps4fs:/usr/src/app/mfsrootdir iwatkot/maps4fs
-```
-
-3. Open your browser and go to [http://localhost:8501](http://localhost:8501).
-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 or source code
-
-🔴 Recommended for developers.  
-🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
-✂️ Map scaling: supported.  
-⚙️ Advanced settings: enabled.  
-🖼️ Texture dissolving: enabled.  
-You can use the Python package to generate maps. Follow these steps:
-
-1. Install the package from PyPI:
-
-```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_code = "fs25"
-game = mfs.Game.from_code(game_code)
-
-dtm_provider = mfs.dtm.SRTM30Provider
-
-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,
-    None,
-    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>
-
-```text
-📁 data
- ┣ 📄 fs22-map-template.zip
- ┗ 📄 fs22-texture-schema.json
-```
-
-So it's recommended to download the `data` directory from the repository and place it in the root of your project.<br>
-
-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 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.
 
 ## Schemas Editor
 

{maps4fs-2.2.71 → maps4fs-2.2.73}/README.md

@@ -23,7 +23,6 @@
   <a href="#Overview">Overview</a> • 
   <a href="docs/step_by_step.md">Create a map in 10 steps</a> •
   <a href="docs/recommendations.md">Practical recommendations</a> •
-  <a href="#How-To-Run">How-To-Run</a><br>
   <a href="docs/my_maps.md">My Maps</a> •
   <a href="docs/FAQ.md">FAQ</a> •
   <a href="docs/map_structure.md">Map Structure</a> •
@@ -120,38 +119,49 @@ There are several ways to use the tool. You obviously need the **first one**, bu
 ### 🚜 For most users
 
 **Option 1:** Open the [maps4fs](https://maps4fs.xyz) and generate a map template in a few clicks.<br>
+🟢 Recommended for all users.  
+🛠️ Don't need to install anything.  
+🗺️ Supported map sizes: 2x2, 4x4, custom sizes not available.  
+✂️ Map scaling: not supported.  
+⚙️ Advanced settings: some settings not available.  
 
 ![Basic WebUI](https://github.com/iwatkot/maps4fs/releases/download/2.0.0/maps4fs_wui.png)
 
 ### 😎 For advanced users
 
-**Option 2:** Run the Docker version in your browser. Launch the following command in your terminal:
-
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs iwatkot/maps4fs
-```
+**Option 2:** Run the Docker version in your browser.  
+🟠 Recommended for users who want bigger maps, fast generation, nice-looking textures, and advanced settings.  
+🛠️ Docker installation required, launch with one command.  
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+✂️ Map scaling: supported.  
+⚙️ Advanced settings: all settings available.
 
-If you want to persist your data, you can mount a directory to the container: 
+Launch the following command in your terminal to use the Setup Wizard:
 
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs -v /c/maps4fs:/usr/src/app/mfsrootdir iwatkot/maps4fs
+```powershell
+powershell -ExecutionPolicy Bypass -Command "iex (iwr 'https://raw.githubusercontent.com/iwatkot/maps4fs/main/setup-wizard.ps1' -UseBasicParsing).Content"
 ```
 
-Learn more in the [My Maps](docs/my_maps.md) documentation.
+ℹ️ Check out detailed instructions about [local deployment](docs/local_deployment.md).
 
-And open [http://localhost:8501](http://localhost:8501) in your browser.<br>
-If you don't know how to use Docker, navigate to the [Docker version](#option-2-docker-version), it's really simple.<br>
-Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
 
 ### 🤯 For developers
 
-**Option 3:** Python package. Install the package using the following command:
+**Option 3:** Python package or run from source code.
+🔴 Recommended for developers who want full control over the generation process and fastest performance.
+🛠️ Requires Python, pip, and Git.
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+✂️ Map scaling: supported.  
+⚙️ Advanced settings: all settings available.
+
+Install the package using the following command:
 
 ```bash
 pip install maps4fs
 ```
 
-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>
+ℹ️ Check out detailed instructions about [Maps4FS Python Package Deployment](docs/local_deployment_source.md).
+
 
 ## Overview
 
@@ -185,134 +195,6 @@ Parameters:
 
 Don't know where to start? Don't worry, just follow this [step-by-step guide](docs/step_by_step.md) to create your first map in 10 simple steps.<br>
 
-## How-To-Run
-
-### Option 1: Public version
-
-🟢 Recommended for all users.  
-🛠️ Don't need to install anything.  
-🗺️ Supported map sizes: 2x2, 4x4.  
-✂️ Map scaling: not supported.  
-⚙️ Advanced settings: partial.  
-🖼️ Texture dissolving: disabled.  
-Using the public version on [maps4fs.xyz](https://maps4fs.xyz) is the easiest way to generate a map template. Just open the link and follow the instructions.
-Note: due to CPU and RAM limitations of the hosting, the generation may take some time. If you need faster processing, use the [Docker version](#option-2-docker-version).<br>
-
-Using it is easy and doesn't require any guides. Enjoy!
-
-### Option 2: Docker version
-
-🟠 Recommended for users who want bigger maps, fast generation, nice-looking textures, and advanced settings.  
-🛠️ Launch with one single command.  
-🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
-✂️ Map scaling: supported.  
-⚙️ Advanced settings: enabled.  
-🖼️ Texture dissolving: enabled.  
-Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
-
-📹 Check out the [video tutorial](https://www.youtube.com/watch?v=1AHGIxTxSBM) on how to install Docker and use the Docker version.  
-
-You can launch the project with minimalistic UI in your browser using Docker. Follow these steps:
-
-1. Install [Docker](https://docs.docker.com/get-docker/) for your OS.
-2. Run the following command in your terminal:
-
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs iwatkot/maps4fs
-```
-
-If you want to persist your data, you can mount a directory to the container:
-
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs -v /c/maps4fs:/usr/src/app/mfsrootdir iwatkot/maps4fs
-```
-
-3. Open your browser and go to [http://localhost:8501](http://localhost:8501).
-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 or source code
-
-🔴 Recommended for developers.  
-🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
-✂️ Map scaling: supported.  
-⚙️ Advanced settings: enabled.  
-🖼️ Texture dissolving: enabled.  
-You can use the Python package to generate maps. Follow these steps:
-
-1. Install the package from PyPI:
-
-```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_code = "fs25"
-game = mfs.Game.from_code(game_code)
-
-dtm_provider = mfs.dtm.SRTM30Provider
-
-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,
-    None,
-    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>
-
-```text
-📁 data
- ┣ 📄 fs22-map-template.zip
- ┗ 📄 fs22-texture-schema.json
-```
-
-So it's recommended to download the `data` directory from the repository and place it in the root of your project.<br>
-
-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 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.
 
 ## Schemas Editor
 

{maps4fs-2.2.71 → maps4fs-2.2.73}/maps4fs/generator/component/dem.py

@@ -7,9 +7,6 @@ import cv2
 import numpy as np
 from pydtmdl import DTMProvider
 
-# import rasterio  # type: ignore
-from pympler import asizeof  # type: ignore
-
 import maps4fs.generator.config as mfscfg
 from maps4fs.generator.component.base.component_image import ImageComponent
 
@@ -297,9 +294,6 @@ class DEM(ImageComponent):
         """
         resampled_data = cv2.resize(data, self.output_resolution, interpolation=cv2.INTER_LINEAR)
 
-        size_of_resampled_data = asizeof.asizeof(resampled_data) / 1024 / 1024
-        self.logger.debug("Size of resampled data: %s MB.", size_of_resampled_data)
-
         return resampled_data
 
     def rotate_dem(self) -> None:

maps4fs-2.2.73/maps4fs/generator/config.py

@@ -0,0 +1,154 @@
+"""This module contains configuration files for the maps4fs generator."""
+
+import os
+import shutil
+import subprocess
+import tempfile
+
+from osmnx import settings as ox_settings
+
+from maps4fs.logger import Logger
+
+logger = Logger()
+
+MFS_TEMPLATES_DIR = os.path.join(os.getcwd(), "templates")
+
+
+def ensure_templates():
+    """Ensure templates directory exists and is populated with data.
+
+    If MFS_TEMPLATES_DIR is empty or doesn't exist, clone the maps4fsdata
+    repository and run the preparation script to populate it.
+    """
+
+    # Check if templates directory exists and has content
+    if os.path.exists(MFS_TEMPLATES_DIR) and os.listdir(MFS_TEMPLATES_DIR):
+        logger.info("Templates directory already exists and contains data: %s", MFS_TEMPLATES_DIR)
+        return
+
+    logger.info("Templates directory is empty or missing, preparing data...")
+
+    # Create templates directory if it doesn't exist
+    os.makedirs(MFS_TEMPLATES_DIR, exist_ok=True)
+
+    try:
+        with tempfile.TemporaryDirectory() as temp_dir:
+            clone_dir = os.path.join(temp_dir, "maps4fsdata")
+
+            logger.info("Cloning maps4fsdata repository to temporary directory...")
+            # Clone the repository with depth 1 (shallow clone)
+            subprocess.run(
+                [
+                    "git",
+                    "clone",
+                    "--depth",
+                    "1",
+                    "https://github.com/iwatkot/maps4fsdata.git",
+                    clone_dir,
+                ],
+                check=True,
+                capture_output=True,
+                text=True,
+            )
+
+            # Make the preparation script executable
+            prep_script = os.path.join(clone_dir, "prepare_data.sh")
+            if os.path.exists(prep_script):
+                os.chmod(prep_script, 0o755)
+
+                logger.info("Running data preparation script...")
+                # Run the preparation script from the cloned directory
+                subprocess.run(
+                    ["./prepare_data.sh"], cwd=clone_dir, check=True, capture_output=True, text=True
+                )
+
+                # Copy the generated data directory to templates directory
+                data_src = os.path.join(clone_dir, "data")
+                if os.path.exists(data_src):
+                    logger.info(
+                        "Copying prepared data to templates directory: %s", MFS_TEMPLATES_DIR
+                    )
+                    # Copy all files from data directory to MFS_TEMPLATES_DIR
+                    for item in os.listdir(data_src):
+                        src_path = os.path.join(data_src, item)
+                        dst_path = os.path.join(MFS_TEMPLATES_DIR, item)
+                        if os.path.isdir(src_path):
+                            shutil.copytree(src_path, dst_path, dirs_exist_ok=True)
+                        else:
+                            shutil.copy2(src_path, dst_path)
+                    logger.info("Templates data prepared successfully")
+                else:
+                    logger.error("Data directory not found after running preparation script")
+                    raise FileNotFoundError(
+                        "Data preparation script did not create expected data directory"
+                    )
+            else:
+                logger.error("Preparation script not found: %s", prep_script)
+                raise FileNotFoundError("prepare_data.sh not found in cloned repository")
+
+    except subprocess.CalledProcessError as e:
+        logger.error("Failed to prepare templates data: %s", str(e))
+        if e.stdout:
+            logger.error("Script stdout: %s", e.stdout)
+        if e.stderr:
+            logger.error("Script stderr: %s", e.stderr)
+        raise
+    except Exception as e:
+        logger.error("Error preparing templates: %s", str(e))
+        raise
+
+
+ensure_templates()
+
+MFS_ROOT_DIR = os.getenv("MFS_ROOT_DIRECTORY", os.path.join(os.getcwd(), "mfsrootdir"))
+MFS_CACHE_DIR = os.path.join(MFS_ROOT_DIR, "cache")
+MFS_DATA_DIR = os.path.join(MFS_ROOT_DIR, "maps")
+os.makedirs(MFS_CACHE_DIR, exist_ok=True)
+os.makedirs(MFS_DATA_DIR, exist_ok=True)
+logger.info(
+    "MFS_ROOT_DIR: %s. MFS_CACHE_DIR: %s. MFS_DATA_DIR: %s.",
+    MFS_ROOT_DIR,
+    MFS_CACHE_DIR,
+    MFS_DATA_DIR,
+)
+
+DTM_CACHE_DIR = os.path.join(MFS_CACHE_DIR, "dtm")
+SAT_CACHE_DIR = os.path.join(MFS_CACHE_DIR, "sat")
+
+osmnx_cache = os.path.join(MFS_CACHE_DIR, "osmnx")
+osmnx_data = os.path.join(MFS_CACHE_DIR, "odata")
+os.makedirs(osmnx_cache, exist_ok=True)
+os.makedirs(osmnx_data, exist_ok=True)
+
+
+ox_settings.cache_folder = osmnx_cache
+ox_settings.data_folder = osmnx_data
+
+
+def get_package_version(package_name: str) -> str:
+    """Get the package version.
+
+    Arguments:
+        package_name (str): The name of the package to check.
+
+    Returns:
+        str: The version of the package, or "unknown" if it cannot be determined.
+    """
+    try:
+        result = subprocess.run(
+            [os.sys.executable, "-m", "pip", "show", package_name],  # type: ignore
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True,
+            check=True,
+        )
+        for line in result.stdout.splitlines():
+            if line.startswith("Version:"):
+                return line.split(":", 1)[1].strip()
+        return "unknown"
+    except Exception:
+        return "unknown"
+
+
+PACKAGE_VERSION = get_package_version("maps4fs")
+logger.info("maps4fs version: %s", PACKAGE_VERSION)

{maps4fs-2.2.71 → maps4fs-2.2.73}/maps4fs/generator/map.py

@@ -67,6 +67,8 @@ class Map:
 
         # region custom OSM properties
         self.custom_osm = custom_osm
+        if custom_osm and not os.path.isfile(custom_osm):
+            raise FileNotFoundError(f"Custom OSM file {custom_osm} does not exist.")
         mfsutils.check_and_fix_osm(self.custom_osm, save_directory=self.map_directory)
         # endregion
 

{maps4fs-2.2.71 → maps4fs-2.2.73}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 2.2.71
+Version: 2.2.73
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: Apache License 2.0
@@ -18,15 +18,13 @@ Requires-Dist: osmnx>=2.0.0
 Requires-Dist: rasterio
 Requires-Dist: geopy
 Requires-Dist: trimesh
-Requires-Dist: imageio
-Requires-Dist: tifffile
-Requires-Dist: pympler
 Requires-Dist: pydantic
 Requires-Dist: pygmdl
 Requires-Dist: owslib
 Requires-Dist: tqdm
 Requires-Dist: scipy
 Requires-Dist: pydtmdl
+Requires-Dist: manifold3d
 Dynamic: license-file
 
 ⚠️ Learn more about the 2.0 changes in the [migration guide](docs/migration.md).  
@@ -54,7 +52,6 @@ Dynamic: license-file
   <a href="#Overview">Overview</a> • 
   <a href="docs/step_by_step.md">Create a map in 10 steps</a> •
   <a href="docs/recommendations.md">Practical recommendations</a> •
-  <a href="#How-To-Run">How-To-Run</a><br>
   <a href="docs/my_maps.md">My Maps</a> •
   <a href="docs/FAQ.md">FAQ</a> •
   <a href="docs/map_structure.md">Map Structure</a> •
@@ -151,38 +148,49 @@ There are several ways to use the tool. You obviously need the **first one**, bu
 ### 🚜 For most users
 
 **Option 1:** Open the [maps4fs](https://maps4fs.xyz) and generate a map template in a few clicks.<br>
+🟢 Recommended for all users.  
+🛠️ Don't need to install anything.  
+🗺️ Supported map sizes: 2x2, 4x4, custom sizes not available.  
+✂️ Map scaling: not supported.  
+⚙️ Advanced settings: some settings not available.  
 
 ![Basic WebUI](https://github.com/iwatkot/maps4fs/releases/download/2.0.0/maps4fs_wui.png)
 
 ### 😎 For advanced users
 
-**Option 2:** Run the Docker version in your browser. Launch the following command in your terminal:
-
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs iwatkot/maps4fs
-```
+**Option 2:** Run the Docker version in your browser.  
+🟠 Recommended for users who want bigger maps, fast generation, nice-looking textures, and advanced settings.  
+🛠️ Docker installation required, launch with one command.  
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+✂️ Map scaling: supported.  
+⚙️ Advanced settings: all settings available.
 
-If you want to persist your data, you can mount a directory to the container: 
+Launch the following command in your terminal to use the Setup Wizard:
 
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs -v /c/maps4fs:/usr/src/app/mfsrootdir iwatkot/maps4fs
+```powershell
+powershell -ExecutionPolicy Bypass -Command "iex (iwr 'https://raw.githubusercontent.com/iwatkot/maps4fs/main/setup-wizard.ps1' -UseBasicParsing).Content"
 ```
 
-Learn more in the [My Maps](docs/my_maps.md) documentation.
+ℹ️ Check out detailed instructions about [local deployment](docs/local_deployment.md).
 
-And open [http://localhost:8501](http://localhost:8501) in your browser.<br>
-If you don't know how to use Docker, navigate to the [Docker version](#option-2-docker-version), it's really simple.<br>
-Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
 
 ### 🤯 For developers
 
-**Option 3:** Python package. Install the package using the following command:
+**Option 3:** Python package or run from source code.
+🔴 Recommended for developers who want full control over the generation process and fastest performance.
+🛠️ Requires Python, pip, and Git.
+🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
+✂️ Map scaling: supported.  
+⚙️ Advanced settings: all settings available.
+
+Install the package using the following command:
 
 ```bash
 pip install maps4fs
 ```
 
-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>
+ℹ️ Check out detailed instructions about [Maps4FS Python Package Deployment](docs/local_deployment_source.md).
+
 
 ## Overview
 
@@ -216,134 +224,6 @@ Parameters:
 
 Don't know where to start? Don't worry, just follow this [step-by-step guide](docs/step_by_step.md) to create your first map in 10 simple steps.<br>
 
-## How-To-Run
-
-### Option 1: Public version
-
-🟢 Recommended for all users.  
-🛠️ Don't need to install anything.  
-🗺️ Supported map sizes: 2x2, 4x4.  
-✂️ Map scaling: not supported.  
-⚙️ Advanced settings: partial.  
-🖼️ Texture dissolving: disabled.  
-Using the public version on [maps4fs.xyz](https://maps4fs.xyz) is the easiest way to generate a map template. Just open the link and follow the instructions.
-Note: due to CPU and RAM limitations of the hosting, the generation may take some time. If you need faster processing, use the [Docker version](#option-2-docker-version).<br>
-
-Using it is easy and doesn't require any guides. Enjoy!
-
-### Option 2: Docker version
-
-🟠 Recommended for users who want bigger maps, fast generation, nice-looking textures, and advanced settings.  
-🛠️ Launch with one single command.  
-🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
-✂️ Map scaling: supported.  
-⚙️ Advanced settings: enabled.  
-🖼️ Texture dissolving: enabled.  
-Check out the [Docker FAQ](docs/FAQ_docker.md) if you have any questions.<br>
-
-📹 Check out the [video tutorial](https://www.youtube.com/watch?v=1AHGIxTxSBM) on how to install Docker and use the Docker version.  
-
-You can launch the project with minimalistic UI in your browser using Docker. Follow these steps:
-
-1. Install [Docker](https://docs.docker.com/get-docker/) for your OS.
-2. Run the following command in your terminal:
-
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs iwatkot/maps4fs
-```
-
-If you want to persist your data, you can mount a directory to the container:
-
-```bash
-docker run -d -p 8501:8501 -p 8000:8000 --name maps4fs -v /c/maps4fs:/usr/src/app/mfsrootdir iwatkot/maps4fs
-```
-
-3. Open your browser and go to [http://localhost:8501](http://localhost:8501).
-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 or source code
-
-🔴 Recommended for developers.  
-🗺️ Supported map sizes: 2x2, 4x4, 8x8, 16x16 km and any custom size.  
-✂️ Map scaling: supported.  
-⚙️ Advanced settings: enabled.  
-🖼️ Texture dissolving: enabled.  
-You can use the Python package to generate maps. Follow these steps:
-
-1. Install the package from PyPI:
-
-```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_code = "fs25"
-game = mfs.Game.from_code(game_code)
-
-dtm_provider = mfs.dtm.SRTM30Provider
-
-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,
-    None,
-    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>
-
-```text
-📁 data
- ┣ 📄 fs22-map-template.zip
- ┗ 📄 fs22-texture-schema.json
-```
-
-So it's recommended to download the `data` directory from the repository and place it in the root of your project.<br>
-
-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 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.
 
 ## Schemas Editor
 

{maps4fs-2.2.71 → maps4fs-2.2.73}/maps4fs.egg-info/requires.txt

@@ -3,12 +3,10 @@ osmnx>=2.0.0
 rasterio
 geopy
 trimesh
-imageio
-tifffile
-pympler
 pydantic
 pygmdl
 owslib
 tqdm
 scipy
 pydtmdl
+manifold3d

{maps4fs-2.2.71 → maps4fs-2.2.73}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maps4fs"
-version = "2.2.71"
+version = "2.2.73"
 description = "Generate map templates for Farming Simulator from real places."
 authors = [{name = "iwatkot", email = "iwatkot@gmail.com"}]
 license = {text = "Apache License 2.0"}
@@ -22,15 +22,13 @@ dependencies = [
     "rasterio",
     "geopy",
     "trimesh",
-    "imageio",
-    "tifffile",
-    "pympler",
     "pydantic",
     "pygmdl",
     "owslib",
     "tqdm",
     "scipy",
     "pydtmdl",
+    "manifold3d",
 ]
 
 [project.urls]

maps4fs-2.2.71/maps4fs/generator/config.py

@@ -1,93 +0,0 @@
-"""This module contains configuration files for the maps4fs generator."""
-
-import os
-import shutil
-import subprocess
-
-from osmnx import settings as ox_settings
-
-from maps4fs.logger import Logger
-
-logger = Logger()
-
-DEFAULT_TEMPLATES_DIR = os.path.join(os.getcwd(), "data")
-MFS_TEMPLATES_DIR = os.getenv("MFS_TEMPLATES_DIRECTORY")
-if MFS_TEMPLATES_DIR is None:
-    logger.info("MFS_TEMPLATES_DIRECTORY is not set. Using default templates directory.")
-    MFS_TEMPLATES_DIR = DEFAULT_TEMPLATES_DIR
-else:
-    logger.info("MFS_TEMPLATES_DIRECTORY is set to: %s", MFS_TEMPLATES_DIR)
-    if not os.path.isdir(MFS_TEMPLATES_DIR):
-        logger.info("Templates directory %s does not exist. Creating it.", MFS_TEMPLATES_DIR)
-        os.makedirs(MFS_TEMPLATES_DIR, exist_ok=True)
-
-    # Check if there any files (directory is empty).
-    if not os.listdir(MFS_TEMPLATES_DIR):
-        logger.info("Templates directory %s is empty. Copying default files.", MFS_TEMPLATES_DIR)
-        for item in os.listdir(DEFAULT_TEMPLATES_DIR):
-            s = os.path.join(DEFAULT_TEMPLATES_DIR, item)
-            d = os.path.join(MFS_TEMPLATES_DIR, item)
-            if os.path.isdir(s):
-                shutil.copytree(s, d, False, None)
-            else:
-                shutil.copy2(s, d)
-        logger.info("Default files copied to %s.", MFS_TEMPLATES_DIR)
-    else:
-        logger.warning(
-            "Templates directory %s is not empty. Will not copy default files. "
-            "Ensure that the directory contains the necessary template files.",
-            MFS_TEMPLATES_DIR,
-        )
-
-MFS_ROOT_DIR = os.getenv("MFS_ROOT_DIRECTORY", os.path.join(os.getcwd(), "mfsrootdir"))
-MFS_CACHE_DIR = os.path.join(MFS_ROOT_DIR, "cache")
-MFS_DATA_DIR = os.path.join(MFS_ROOT_DIR, "data")
-os.makedirs(MFS_CACHE_DIR, exist_ok=True)
-os.makedirs(MFS_DATA_DIR, exist_ok=True)
-logger.info(
-    "MFS_ROOT_DIR: %s. MFS_CACHE_DIR: %s. MFS_DATA_DIR: %s.",
-    MFS_ROOT_DIR,
-    MFS_CACHE_DIR,
-    MFS_DATA_DIR,
-)
-
-DTM_CACHE_DIR = os.path.join(MFS_CACHE_DIR, "dtm")
-SAT_CACHE_DIR = os.path.join(MFS_CACHE_DIR, "sat")
-
-osmnx_cache = os.path.join(MFS_CACHE_DIR, "osmnx")
-osmnx_data = os.path.join(MFS_CACHE_DIR, "odata")
-os.makedirs(osmnx_cache, exist_ok=True)
-os.makedirs(osmnx_data, exist_ok=True)
-
-
-ox_settings.cache_folder = osmnx_cache
-ox_settings.data_folder = osmnx_data
-
-
-def get_package_version(package_name: str) -> str:
-    """Get the package version.
-
-    Arguments:
-        package_name (str): The name of the package to check.
-
-    Returns:
-        str: The version of the package, or "unknown" if it cannot be determined.
-    """
-    try:
-        result = subprocess.run(
-            [os.sys.executable, "-m", "pip", "show", package_name],  # type: ignore
-            stdout=subprocess.PIPE,
-            stderr=subprocess.PIPE,
-            text=True,
-            check=True,
-        )
-        for line in result.stdout.splitlines():
-            if line.startswith("Version:"):
-                return line.split(":", 1)[1].strip()
-        return "unknown"
-    except Exception:
-        return "unknown"
-
-
-PACKAGE_VERSION = get_package_version("maps4fs")
-logger.info("maps4fs version: %s", PACKAGE_VERSION)