Skip to content

Installation

Jump to bottom
Wolren edited this page Apr 28, 2026 · 5 revisions

Installation & Usage

LIRiAP can be installed and used in two ways in QGIS.

Option 1: As Script Folder (Quick Testing)

This method is useful for quick testing and experiments without enabling a full plugin.

Steps

  1. Locate your QGIS scripts folder:

    • Windows: C:\Users\<username>\AppData\Roaming\QGIS\QGIS3\profiles\default\processing\scripts\
    • Linux: ~/.local/share/QGIS/QGIS3/profiles/default/processing/scripts/
    • macOS: ~/Library/Application Support/QGIS/QGIS3/profiles/default/processing/scripts/

  2. Copy the algorithm pack:

    • Copy the LIRiAP_pack folder into the scripts folder

  3. Restart QGIS (if already open)

  4. Use the algorithms:

    • Open Processing Toolbox (Processing → Toolbox)
    • Search for "LIRiAP"
    • Algorithms appear under Scripts → LIRiAP

Notes

  • This method doesn't require enabling a plugin
  • Changes to scripts require QGIS restart to take effect
  • Good for testing individual algorithms

Option 2: As Plugin Provider (Recommended)

This is the recommended method for regular use, as it provides better integration with QGIS.

Steps

  1. Locate your QGIS plugins folder:

    • Windows: C:\Users\<username>\AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins\LIRiAP\
    • Linux: ~/.local/share/QGIS/QGIS3/profiles/default/python/plugins/LIRiAP/
    • macOS: ~/Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins/LIRiAP/

  2. Copy the plugin files: Create the LIRiAP folder and copy:

    • The LiRiAP_provider/ folder
    • The LIRiAP_pack/ folder

  3. Enable the plugin:

    • Open QGIS
    • Go to Plugins → Manage and Install Plugins
    • Find "LIRiAP" in the list
    • Check the box to enable it

  4. Verify installation:

    • Open Processing Toolbox
    • Look for "LIRiAP" group in the algorithm list

Running an Algorithm

  1. Open Processing Toolbox: Processing → Toolbox (or press Ctrl+Alt+T / Cmd+Alt+T)

  2. Find the algorithm: Search for specific algorithm name or expand the LIRiAP group

  3. Configure and run: Select input layer, adjust parameters, click Run

  4. View results: Output layer is created (in memory or saved)

Dependencies

Required

  • NumPy, SciPy, Shapely (typically included with QGIS)

Optional: Numba (Recommended)

Numba provides JIT compilation that significantly speeds up computations.

pip install numba

Or enable AUTO_INSTALL_NUMBA in algorithm settings.

Troubleshooting

Algorithms not appearing:

  • Verify correct folder location
  • Check for Python errors in Log Messages panel (View → Panels → Log Messages → Python)

"Module not found" errors:

pip install numpy scipy shapely numba

Navigation

Getting Started

Algorithms

Theory

Performance

Reference

Clone this wiki locally