Getting started¶

Quick install¶

To quickly install the latest released version, add the following repository to your QGIS plugin repositories :

https://evs-gis.github.io/fct-qgis/repo/plugins.xml

Then check the Show experimental plugins box, and install the Fluvial Corridor Toolbox plugin with the QGIS plugin manager.

This package does not contain optional dependencies and cython extensions. If you want to use them, you need to follow the instruction below.

On all platforms, you can install/update the plugin automatically with doit dependency. Install it with:

python -m pip install doit

Then, the following command will install the plugin in your local plugin folder:

python -m doit install

On Windows, copy the directory fct to your local plugin folder, and rename it to FluvialCorridorToolbox.

On Linux or Mac OS, you can use the provided Makefile.

The following command will install the plugin in your local plugin folder :

make

If needed, you can set QGIS_USER_DIR to point to your local folder where QGis stores installed plugins.

make QGIS_USER_DIR=/path/to/qgis/plugin/folder

On Linux, the default is $(HOME)/.local/share/QGIS/QGIS3/profiles/default.

The recommended way to install dependencies is using pip. pip is installed by default in recent versions of Python.

pip3 install -r requirements.txt

You can build and install the Cython extension for Terrain Analysis algorithms with the following command :

make extensions

Alternatively, you can cd into the cython directory and type :

python3 setup.py install --install-platlib=/path/to/plugin/lib

where /path/to/plugin is the installation folder for the FCT plugin, for example $QGIS_USER_DIR/FluvialCorridorToolbox.