# Installation

## Stable version (recommended)

This plugin is published on the official QGIS plugins repository: <https://plugins.qgis.org/plugins/hedge_tools/>.

### LiDAR module

All tools that use LiDAR, except [Generate tree cover](processing/lidar/generate_tc.md), require additional dependencies. If these dependencies are not available, the algorithms will be disabled and will not appear in the QGIS Processing Toolbox.

#### Dependencies installation

```{container} parameter

Windows
```

It is recommended to install the dependencies using the OSGeo4W installer. When selecting the packages, make sure to choose:

- **python3-scipy**.
- **pdal: PDAL – Point Data Abstraction Library (Executable)**.
- **python3-pdal: Point cloud data processing**

Make sure you also have:

- **grass: GRASS GIS**
- **gdal: The GDAL/OGR library and commandline tools**

After restarting QGIS, LiDAR algorithms should be displayed. Otherwise, a warning will appear in the QGIS interface indicating which dependency is missing.

```{container} parameter

Linux
```

To install the dependencies, it is recommended to use Anaconda to install QGIS and HedgeTools LiDAR dependencies.  
If Anaconda is not available on your system, you can follow their [installation procedure](https://www.anaconda.com/docs/getting-started/anaconda/install#linux-installer).

Once Anaconda is installed, it is recommended to create a new environment to avoid conflicts with other libraries:

In your terminal:

```bash
conda create --name custom_name
```

You can then activate the environment:

```bash
conda activate custom_name
```

Next, install the dependencies and QGIS LTR in your environment:

```bash
conda install -c conda-forge/label/qgis_ltr -c conda-forge qgis scipy pdal
```

If you want to install a specific version of QGIS:

```bash
conda install -c conda-forge qgis=3.40 scipy pdal
```

Finally, you can launch QGIS. Your profile, plugins, and default settings should still be available:

```bash
qgis
```

After starting QGIS, the LiDAR algorithm should be displayed. Otherwise, a warning will appear in the QGIS interface indicating which dependency is missing.

```{admonition} Remark
:class: note
For future use, remember to activate your custom environment before launching QGIS.
```

```{admonition} Remark
:class: note
If you need additional dependencies to run other plugins, you can install them using:  
<code>conda install [-c channel] [package...]</code>
```

<!-- ````{tab-set}

```{tab-item} Windows
It is recommended to install the dependencies using the OSGeo4W installer.  
When selecting the packages, make sure to choose:

- **python3-scipy**.
- **pdal: PDAL – Point Data Abstraction Library (Executable)**.
- **python3-pdal: Point cloud data processing**.  
```

```{tab-item} Linux
To install the dependencies, it is recommended to use the QGIS Python Console available at *Plugins > Python Console*.  

In the console, run: <code>!pip install pdal scipy</code>

```

```` -->

## HedgeTools in python

The plugin provides a Python API, making the algorithms accessible directly from your IDE.

### Prerequisites

- QGIS >= 3.40 along with it's python bindings

### Virtual environment creation

An environment with qgis bindings is needed. To create it easily i recommend using the [qgis-venv-creator](https://github.com/GispoCoding/qgis-venv-creator) project by GipsoCoding.

In your terminal you can do the following :

```{admonition} qgis-venv-creator installation
:class: note

Install using pipx: <code>pipx install qgis-venv-creator</code>

Or in an existing environment <code>pip install qgis-venv-creator</code>
```

```{admonition} Create your pyQgis environment
:class: note
<code>create-qgis-venv --venv-name "qgis_bindings.venv"</code>

If multiple QGIS installation are detected the prompt will ask you to choose one.
```



```{admonition} Activate your venv
:class: note
<code>qgis_bindings.venv/Scripts/activate</code>
```

You should be able to use qgis python bindings. And if you activate this environment in your IDE you should have autocompletion available.

You can then use HedgeTools inside your IDE. The documentation is available in the [Python API](./python_api/index.md) section