Skip to content

Latest commit

 

History

History
143 lines (94 loc) · 5.08 KB

DEVELOPMENT.md

File metadata and controls

143 lines (94 loc) · 5.08 KB
Raw

Semi Automatic Classification Plugin (SCP)

SCP The Semi-Automatic Classification Plugin (SCP) is a free open source plugin for QGIS that allows for the supervised classification of remote sensing images, providing tools for the download, the preprocessing and postprocessing of images.

The overall objective of SCP is to provide a set of intertwined tools for raster processing in order to make an automatic workflow and ease the land cover classification, which could be performed also by people whose main field is not remote sensing.

Search and download is available for ASTER, GOES, Landsat, MODIS, Sentinel-1, Sentinel-2, and Sentinel-3 images. Several algorithms are available for the land cover classification. This plugin requires the installation of GDAL, OGR, Numpy, SciPy, and Matplotlib. Some tools require also the installation of SNAP (ESA Sentinel Application Platform).

Contributing to the development

These instructions will get you a copy of the plugin up and running on your local machine for development and testing purposes.

You do not need any of these steps if you are just interested in using the plugin.

Before contributing

If you find a bug of if you want to add a new feature, create a new issue on GitHub to discuss it with the community. Other developers can provide valuable feedback that can improve and make your proposal or your fix even better.

Prerequisites

This SCP is for QGIS 3.x. It uses Python 3.x.

Check that you have installed scipy, matplotlib and numpy. To check:

python3
import scipy;
>>> import scipy;
>>> print(scipy.__version__);
1.0.0

Do the same for matplotlib and numpy.

If necessary, install the required libraries, using easy_install or pip. Use easy_install3 and pip3 if you have both Python 2.x and 3.x.

sudo easy_install3 scipy

Workflow overview

Create a fork of the project, using GitHub interface.

Clone your fork on your local computer. You can do it on the command line with:

mkdir -p ~/dev
git clone [email protected]:yourgithubusername/SemiAutomaticClassificationPlugin.git

Your fork will called origin. Check that with:

cd SemiAutomaticClassificationPlugin
git remote -v
origin	[email protected]:yourgithubusername/SemiAutomaticClassificationPlugin.git (fetch)
origin	[email protected]:yourgithubusername/SemiAutomaticClassificationPlugin.git (push)

Add the original repository with the alias upstream with:

git remote add upstream https://github.com/semiautomaticgit/SemiAutomaticClassificationPlugin

To contribute

Create a new branch.

git checkout -b mycontribution

Make your changes. Compile and test your changes (more details about this on the next section).

When you have done your edits, commit your local changes, with something like:

git commit -m "add some useful enhancement"

Push your changes back to your GitHub repository fork with:

git push origin mycontribution

You are now ready to issue your Pull Request. Go to your GitHub repository interface and make your Pull Request online.

Compile and deploy on your local computer

cd ~/dev/SemiAutomaticClassificationPlugin/
make deploy

make deploy will copy the plugin to your QGIS 3 default profile.

If you want to test your modifications in other computers or to distribute to others for testing purposes, create a zip archive with:

make package VERSION=mycontribution

This will create a new archive SemiAutomaticClassificationPlugin.zip.

In QGIS 3 you can install a plugin from the zip archive using the plugin manager interface.

Install SCP from zip archive

Test the SCP

Start QGIS 3 and check if the plugin is properly installed. If you are running QGIS in another computer or using another profile, install the plugin from the zip file.

and install the plugin from the zip file created.

End user test

Test your bug fixes or new features carefully. Make sure you did not break any existing code.

Do some screen captures of the new enhancements to publish if you want to issue a pull request.

Contributing

If the code is working as you expect, follow the steps already mentioned to issue a pull request.

  1. Commit your local changes, with something like:
git commit -m "add some useful enhancement"

Push your changes to your GitHub repository with:

git push origin mycontribution

Go to your GitHub repository interface and make your Pull Request. Please be verbose on your comments.

After doing your Pull Request, make sure you are available to provide feedback to questions and comments to your contribution from other developers. In the absence of any feedback concerning your Pull Request, it will be closed.

Authors

  • Luca Congedo

See also the list of contributors who participated in this project.

License

This plugin is distributed under a GNU General Public License version 3. To contribute you must accept this license.