WELCOME TO GISWATER PROJECT (gw_example_plugin)

This repo is focused to build-up an example plugin and use it to learn how to create QGIS and Giswater plugins using Giswater libraries.

TABLE OF CONTENTS

Here after you will find all the information you need to getting started with gw_giswater_plugin

1- Requirements
2- Install
3- Test
4- Development
5- License
6- Thanks to

REQUIREMENTS

Since gw_example_plugin is a plugin that's buil to work with a Giswater project, you will need to have Giswater plugin installed.

For more information about to getting started with Giswater
you can visit the README.md file of one the main repositories:

https://github.com/Giswater/docs
https://github.com/Giswater/giswater_qgis_plugin.
https://github.com/Giswater/giswater_dbmodel.

If you already have Giswater installed and active, you'll only need to install this plugin.

INSTALL

In this point you will learn how to install gw_example_plugin.

To install the plugin you will need to download the source code. You can download the .ZIP file directly from this repository. Once you have de .ZIP file you must extract it in the QGIS plugins folder*:

C:\Users\user\AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins

*This is the location of the QGIS plugins folder in Windows. The location may be diffrent in other operating systems.

After that you can open QGIS and a Giswater project and activate the plugin. To activate the plugin you must find Plugins in the QGIS Menu Toolbar and then go to Manage and Install Plugins > Installed and click the checkbox for giswater_plugin_example.

TEST

Here below you can find a video about how to get started working with giswater_example_plugin and Python:

Python Workshop with Giswater (ENG): https://www.youtube.com/watch?v=230zGmxlqB0&feature=youtu.be

Taller de Python con Giswater (ESP): https://www.youtube.com/watch?v=dVXmUQFJRe4&ab_channel=Giswater

DEVELOPMENT

Once you have a project and both Giswater and gw_example_plugin acitvated you can start using the plugin.

This example plugin uses (imports) libraries from the Giswater plugin to work (lib_* and tools_*). You can use gw_example_plugin as a guide or starting point to learn how Giswater works and extend this example plugin with new buttons and functionalities.

But more importantly, you can use the Giswater libraries to create your own QGIS plugins, note that to import the Giswater libraries you must have Giswater plugin installed, but it is not mandatory to be activated in QGIS.

LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See LICENSE file for more information.

THANKS TO

GITS-BarcelonaTech University
Aigües de Mataró
Aigües de Girona
Aigües de Blanes
Aigües del Prat
Aigües de Vic
Aigües de Castellbisbal
Aigües de Banyoles
Figueres de Serveis, S.A
Prodaisa
Sabemsa
Consorci Aigües de Tarragona

---