Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added documentation to another file
  • Loading branch information
SannaJokela authored Nov 17, 2023
1 parent c5d3ef5 commit f7b5257
Showing 1 changed file with 3 additions and 43 deletions.
46 changes: 3 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ This plugin is available from the official plugin repository and can be installe

<img width="500" alt="image" src="https://github.com/GispoCoding/NLSgpkgloader/assets/23258285/75e6d422-740b-46f8-b225-3121ebab91bd)">

## Usage and installation

Please read [Instructions.md](nlsgpkgloader/Documentation/Instructions.md) for more information.

## Licences

Expand All @@ -37,47 +40,4 @@ The plugin source code is licensed under GPL v3.0, see [LICENCE](LICENCE).

The QGIS layer styles in [layer_styles.sql](nlsgpkgloader/resources/data/layer_styles.sql) are licensed under CC-BY-4.0, see [LICENCE.CC-BY-4](LICENCE.CC-BY-4).

## Installation instructions

The plugin can be found from QGIS official repository: https://plugins.qgis.org/plugins/NLSgpkgloader-master/

Go to QGIS 3.X, Plugins and find "NLS GeoPackage Downloader" and install.

<img width="474" alt="image" src="https://github.com/GispoCoding/NLSgpkgloader/assets/23258285/2998b82c-72a0-4ad7-b8c5-7de5066b2d12">

## Usage

Using the plugin is fairly straightforward:

1. Click the NLS plugin icon or go to Plugins/NLS GeoPackage Downloader.

2. First time you use the plugin a Settings window opens. Enter the valid identification key (received via email from NLS)
and set the save directory. If this does not happen check step 3. You can also define in the Settings where the datasets are downloaded.

<img width="248" alt="image" src="https://github.com/GispoCoding/NLSgpkgloader/assets/23258285/1845eef6-156b-4566-bd05-1f14a1b2fdde">

3. After this another pop-up window, Download Data, opens. If the Settings window did not open as described, you can
find it by pushing Settings button in the left bottom corner of the Download Data window.

<img width="277" alt="image" src="https://github.com/GispoCoding/NLSgpkgloader/assets/23258285/cda6db89-750b-400e-9cf6-d21dd4906d36">

4. Now you can choose which layers and from what area you want to download the data. Note: the datasets are quite heavy, so it might take time if you choose a large area.
- Select the layers you want: Note that some layers are preselected because they have ready made visualisations. If you need data from only one layer deselect the layers you do not need.

<img width="194" alt="image" src="https://github.com/GispoCoding/NLSgpkgloader/assets/23258285/7c16edf6-2414-4e86-9798-fc77d8f409ed">

- If you want the data from a certain municipality, choose the municipality form the list

<img width="194" alt="image" src="https://github.com/GispoCoding/NLSgpkgloader/assets/23258285/b3bf4739-7214-4be4-aac1-4aef2c8c7ab8">

- If you want to choose the data from a layer: choose Municipalities, UTM Grids or Sea Grids and the layers open to QGIS Layer-panel. There you can choose the wanted area by QGIS's select tools. You can also select multiple grids/municipalities at a same time.

<img width="583" alt="image" src="https://github.com/GispoCoding/NLSgpkgloader/assets/23258285/3f91d7e8-3cf0-409f-946b-3287a51a7449">

5. Enter a filename. If you wish to load the GeoPackage layers into QGIS, activate Load data check box.

6. Click OK and wait for processing to finish. The tool fetches all the wanted layers and those that were preselected are always visualised and rule based visualisation created for certain classes. Also scale has been taken into accout so that e.g. road classes are shown differently in different scales. These can be edited via layer styling panel.

![image](https://github.com/GispoCoding/NLSgpkgloader/assets/23258285/ed4c8c2e-599b-4c10-8ec7-606d385aaa40)

Read more about usage in Documentation.

0 comments on commit f7b5257

Please sign in to comment.