plTools package includes binaries for plMapcalc, plForestFragment, plGeoAdaptels, plGeoJSEG, plDarkSky, plClump4p, and QGIS plugin

README.md

Installation procedure

Linux

Download pltoolsinstall.run file. Set executable attribute:

chmod +x pltoolsinstall.run

The installer requires tools as follows: GDAL, bash, awk, and grep. It will copy all binary files and set environmental variables. The installation can be executed as a regular user or as a root. In the case of istallation process in the context of regular user, the software will be placed into ~/bin/pltools directory and user's .bashrc will modyfied. In the case of istallation process in the context of regular user, the software will be placed into /opt/pltools directory and configuration file will be added to /etc/profile.d directory.

There is an uninstall script to remove plTools from the system. It is called pluninstall.sh. The script removes all binaries and clean configuration.

Windows

Download pltoolsinstall.exe file. Run the file as an administrator.

The installer will copy all binary files to Program Files\pltools directory and set PLTOOLSPATH environmental variable. The sysyem neds to be restarted after installation.

To remove plTools form the system it's enough to remove the directory and delete PLTOOLSPATH variable form configuration.

QGIS plugin

Download pltool.zip file. Run QGIS and start plugin menager. Install the plugin from local zip file. It is obligatory to install plTools binaries before the plugin installation.

Python module

The plTools package includes a module that allows to execute plTools programs from the Python language level. The module can be used in Python scripts, interactively in the interpreter, and in the Jupyter environment.

To use this module you need to perform the following steps:

import sys
import os
sys.path.append(os.path.join(os.environ['PLTOOLSPATH'], 'python'))

import plTools as plt

After performing the above steps the following functions will be available:

  • plt.plmapcalc(),
  • plt.plclump4p(),
  • plt.plforestfragment(),
  • plt.pldarksky(),
  • plt.plgeojseg(),
  • plt.plgeoadaptels().