Skip to contents

Installing LCZ4r in QGIS

Max Anjos

April 02, 2025

Source: vignettes/instalation_lcz4r_qgis.Rmd
instalation_lcz4r_qgis.Rmd

🚀 Getting Started: Installing LCZ4r in QGIS

Welcome to the LCZ4r-QGIS plugin installation guide! This document will guide you through the setup process to enable Local Climate Zone (LCZ) analysis within QGIS. With LCZ4r, you can enhance urban climate analysis by integrating advanced R functionalities directly into your GIS environment.

You can watch a detailed tutorial on installing LCZ4r in QGIS below:

📌 Prerequisites

Before proceeding, ensure that you have the following:

  • QGIS: Download and install QGIS, a popular open-source Geographic Information System.
  • R: Download and install R for statistical computing, which is essential for running LCZ4r scripts within QGIS.

🗃 Step-by-Step Installation Guide

1. Install the R

The R is an open-source software environment for statistical computing and graphics, required for running LCZ4r scripts. Follow these steps:

  • Got to CRAN to download and install R, following the instructions for your operating system (Windows, macOS, or Linux).
  • Tip: Ensure R is properly configured in your system’s PATH so that QGIS can communicate with it.

2. Install the Processing R Provider in QGIS

The Processing R provider plugin allows you to run R scripts directly in QGIS. To install it:

  1. Open QGIS and go to Plugins > Manage and Install Plugins.
  2. Search for “Processing R Provider” and click Install.
  3. Once installed, ensure the plugin is activated in Plugins > Installed.

3. Download and install the LCZ4r Scripts

To integrate LCZ4r functionality into QGIS, you need to download the R scripts for your preferred language:

    1. Visit the QGIS-LCZ4r Integration page.
    1. Download the R scripts in your preferred language.
    1. Unzip the downloaded file and save the scripts in an easily accessible location.
    1. Open QGIS and got to Settings > Options… > Processing > Providers > R.
    1. Under R scripts folder, add the path where you saved the LCZ4r scripts.
    1. Disable Use user library instead of system libraries.
  • 7.Click OK to confirm your setup.

If everything is configured correctly, you will see LCZ4r General Functions, LCZ4r Local Functions, and LCZ4r Setup Functions in the Processing Toolbox >R below Example Scripts.

4. Install the LCZ4r package and additional necessary packages

Begin by running the Install LCZ4r function under LCZ4r Setup Functions. This step will install the LCZ4r package along with any additional necessary packages.

💡 Please note that the first time you run this script, it may take longer as it installs all dependencies. Thank you for your patience!

5. Run your first LCZ4r Script

Next, run the Download LCZ map function under LCZ4r General Functions.

🌟 Once the process is complete, you should see the output LCZ map. Congratulations! You’re now ready to explore the functions of the LCZ4r-QGIS plugin!.

6. Upgrade LCZ4r regularly and select language functions

To ensure you benefit from the latest improvements (including new languages), run the Upgrade LCZ4r function under LCZ4r Setup Functions.

Select the folder where the script be stored. To do this, navigate first to the same directory where the scripts are installed:

🌟Open QGIS and got to Settings > Options… > Processing > Providers > R > R scripts folder.

Next, select your language and click Run.

📬 Have feedback or suggestions?

We welcome your feedback and suggestions! If you have ideas for improvements or spot any issues, please let us know. Click the button below to submit a new issue on our GitHub repository.