Merging map2loop plugin into LoopStructural

.github/labeler.yml

@@ -45,7 +45,6 @@ tooling:
         - .pre-commit-config.yaml
         - setup.cfg
 
-
 UI:
   - head-branch:
     - ^ui

.github/workflows/linter.yml

@@ -19,7 +19,6 @@ env:
 permissions:
   contents: write
 
-
 jobs:
   lint-py:
     name: Python 🐍

.github/workflows/package_and_release.yml

@@ -0,0 +1,168 @@
+name: "📦 Package & 🚀 Release"
+
+env:
+  PROJECT_FOLDER: plugin_map2loop
+  PYTHON_VERSION: 3.9
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .github/workflows/package_and_release.yml
+      - 'docs/**/*'
+      - "plugin_map2loop/**/*.py"
+      - "plugin_map2loop/metadata.txt"
+    tags:
+      - "*"
+
+# Allow one concurrent deployment per branch/pr
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  translation:
+    name: "💬 i18n compilation"
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Get source code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install translation requirements
+        run: |
+          sudo apt update
+          sudo apt install qt5-qmake qttools5-dev-tools
+          python3 -m pip install -U pyqt5-tools
+
+      - name: Update translations
+        run: |
+            python3 scripts/generate_translation_profile.py
+            pylupdate5 -noobsolete -verbose ${{ env.PROJECT_FOLDER }}/resources/i18n/plugin_translation.pro
+
+      - name: Compile translations
+        run: lrelease ${{ env.PROJECT_FOLDER }}/resources/i18n/*.ts
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: translations-build
+          path: ${{ env.PROJECT_FOLDER }}/**/*.qm
+          if-no-files-found: error
+
+  # -- NO TAGS ----------------------------------------------------------------------
+  packaging:
+    name: "📦 Packaging plugin"
+    runs-on: ubuntu-latest
+    needs:
+      - translation
+
+    if: ${{ !startsWith(github.ref, 'refs/tags/') }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          cache: "pip"
+          cache-dependency-path: "requirements/packaging.txt"
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip setuptools wheel
+          python -m pip install -U -r requirements/packaging.txt
+
+      - name: Download translations
+        uses: actions/download-artifact@v4
+        with:
+          name: translations-build
+          path: ${{ env.PROJECT_FOLDER }}
+
+      - name: Amend gitignore to include compiled translations and add it to tracked files
+        run: |
+          # include compiled translations
+          sed -i "s|^*.qm.*| |" .gitignore
+
+          # git add full project
+          git add ${{ env.PROJECT_FOLDER }}/
+
+      - name: Package the latest version
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          qgis-plugin-ci package latest \
+            --allow-uncommitted-changes \
+            --plugin-repo-url $(gh api "repos/$GITHUB_REPOSITORY/pages" --jq '.html_url')
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.PROJECT_FOLDER }}-latest
+          path: |
+            plugins.xml
+            ${{ env.PROJECT_FOLDER }}.*.zip
+          if-no-files-found: error
+
+  # -- ONLY TAGS ----------------------------------------------------------------------
+  release:
+    name: "🚀 Release on tag"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    needs:
+      - translation
+
+    if: startsWith(github.ref, 'refs/tags/')
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          cache: "pip"
+          cache-dependency-path: "requirements/packaging.txt"
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install project requirements
+        run: |
+          python -m pip install -U pip setuptools wheel
+          python -m pip install -U -r requirements/packaging.txt
+
+      - name: Download translations
+        uses: actions/download-artifact@v4
+        with:
+          name: translations-build
+          path: ${{ env.PROJECT_FOLDER }}
+
+      - name: Amend gitignore to include compiled translations and add it to tracked files
+        run: |
+          # include compiled translations
+          sed -i "s|^*.qm.*| |" .gitignore
+
+          # git add full project
+          git add ${{ env.PROJECT_FOLDER }}/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          fail_on_unmatched_files: true
+          generate_release_notes: true
+
+      - name: Deploy plugin
+        run: >-
+          qgis-plugin-ci
+          release ${GITHUB_REF/refs\/tags\//}
+          --allow-uncommitted-changes
+          --create-plugin-repo
+          --github-token ${{ secrets.GITHUB_TOKEN }}
+          --osgeo-username ${{ secrets.OSGEO_USER }}
+          --osgeo-password ${{ secrets.OSGEO_PASSWORD }}

.github/workflows/release-please.yml

@@ -1,4 +1,3 @@
-
 on:
   push:
     branches:

.release-please-manifest.json

@@ -1,4 +1,4 @@
 {
   ".": "0.0.1",
   "loopstructural": "0.1.11"
-}
+}

AGENTS.md

@@ -0,0 +1,93 @@
+# AGENTS.md
+
+## Purpose
+
+This document outlines the architectural and development principles for contributors to the `plugin_loopstructural` QGIS plugin. The plugin provides a thin, modular interface to the `map2loop` and `LoopStructural` libraries, enabling geological modeling workflows within QGIS.
+
+---
+
+## Design Philosophy
+
+### 🔹 Thin Interface Layer
+- The plugin **must not** reimplement or duplicate functionality from `map2loop` or `LoopStructural`.
+- All core logic and enhancements should be contributed upstream to the respective libraries.
+- The plugin should focus on **UI integration**, **data flow orchestration**, and **user interaction**.
+
+### 🔹 Modularity
+- UI components (dialogs, panels, actions) live under the `loopstructural/gui/` package and should be encapsulated in their own classes.
+- Business logic and orchestration are located in `loopstructural/main/` and `loopstructural/toolbelt/` where adapters and services wrap external libraries.
+- Processing algorithms and QGIS provider integration are in `loopstructural/processing/` and should be isolated from UI code.
+- Avoid tight coupling between components. Use signals/slots or event-driven patterns where appropriate.
+
+### 🔹 Object-Oriented Design
+- Use classes with clear responsibilities and interfaces.
+- Prefer composition over inheritance unless subclassing is semantically appropriate.
+- Encapsulate interactions with external libraries in dedicated adapter or service classes (e.g., `loopstructural.main.Map2LoopService`, `loopstructural.main.LoopStructuralRunner`).
+
+---
+
+## Development Guidelines
+
+### ✅ Code Quality
+- All code must pass the repository's pre-commit checks (formatting, linting, import sorting).
+- Use type hints and docstrings for all public methods and classes.
+- Follow PEP8 and QGIS plugin development best practices.
+
+### 🧪 Testing
+- All new code must include **unit tests** and, where applicable, **integration tests**.
+- Tests live under the `tests/` package and are runnable with `pytest`.
+- Mock external dependencies (`map2loop`, `LoopStructural`) in unit tests.
+
+### 🧩 Current Plugin Structure
+
+```
+plugin_loopstructural/
+├── loopstructural/           # plugin package
+│   ├── __init__.py
+│   ├── __about__.py
+│   ├── plugin_main.py        # QGIS plugin entry and bootstrap
+│   ├── gui/                  # UI dialogs, widgets, and panels
+│   ├── main/                 # controllers, managers, adapters (service layer)
+│   ├── processing/           # QGIS processing provider and algorithms
+│   ├── toolbelt/             # utilities, env parsing, preferences, logging
+│   ├── resources/            # icons, translations, help files
+│   └── requirements.txt
+├── docs/
+├── requirements/
+├── tests/
+└── README.md
+```
+
+Notes on mapping older concepts:
+- What used to be called `services/` and `controllers/` is implemented across `loopstructural/main/` and `loopstructural/toolbelt/`.
+- UI remains in `loopstructural/gui/` (dialogs, `.ui` files, widget classes).
+- Processing-specific code and QGIS provider live under `loopstructural/processing/`.
+
+---
+
+## Contribution Workflow
+
+1. Fork the repository and create a feature branch.
+2. Implement changes following the design and code quality guidelines.
+3. Add or update tests under `tests/` and ensure they run with `pytest`.
+4. Run pre-commit hooks (e.g. `pre-commit run --all-files`) and ensure all checks pass.
+5. Submit a pull request with a clear description of the changes and rationale. Link to upstream libraries if behavior is moved upstream.
+
+---
+
+## Future Enhancements
+
+- Support for asynchronous or background processing of long-running tasks (consider using QGIS background task framework).
+- Improved error handling and user feedback.
+- Internationalization (i18n) support and keeping `.ts`/.qm translation files in `loopstructural/resources/i18n/`.
+- Better separation of concerns between UI, processing algorithms and adapters to facilitate unit testing.
+
+---
+
+## Contact
+
+For questions or contributions to the upstream libraries:
+- `map2loop`
+- `LoopStructural`
+
+---

LICENSE

@@ -2,7 +2,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 2, June 1991
 
- Copyright (c) 2024, Lachlan GROSE / QGIS
+ Copyright (c) 2025, Lachlan GROSE / QGIS
  Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  Everyone is permitted to copy and distribute verbatim copies

docs/conf.py

@@ -1,7 +1,6 @@
 #!python3
 
-"""Configuration for project documentation using Sphinx.
-"""
+"""Configuration for project documentation using Sphinx."""
 
 # standard
 import sys

docs/development/environment.md

@@ -8,7 +8,6 @@ Typically on Ubuntu:
 # create virtual environment linking to system packages (for pyqgis)
 python3 -m venv .venv --system-site-packages
 source .venv/bin/activate
-
 # bump dependencies inside venv
 python -m pip install -U pip
 python -m pip install -U -r requirements/development.txt