Skip to content

Commit 43999b1

Browse files
SannaJokelaismogis
andauthored
Updates on readme and new instructions (#33)
* Update README.md Added images and process to instructions Added short description in Finnish Added documentation to another file * Create Instructions.md * Renamed files * Moved images to documentation folder * Formatted markdowns * Added alternative texts for images --------- Co-authored-by: Ismo Lahtinen <[email protected]>
1 parent 2a4e34b commit 43999b1

9 files changed

+67
-24
lines changed

README.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
11
# NLS GeoPackage Downloader QGIS plugin
22

3-
This plugin lets users download NLS.fi open MTK data (CC-BY 4.0) using QGIS3. It utilizes the NLS Open data file updating service (Atom feed). You need to order a user-specific identification key from NLS to be able to use this plugin: http://www.maanmittauslaitos.fi/en/e-services/open-data-file-download-service/open-data-file-updating-service-interface.
3+
## Shortly in Finnish
44

5-
Please report any issues you discover.
5+
Tällä QGIS 3 -lisäosalla voit hakea Maanmittauslaitoksen maastotietokannasta karttalehdittäin tai alueittain kohteita valmiiksi visualisoituna ja yhdisteltynä.
66

7-
This plugin is available from the official plugin repository and can be installed from the QGIS Plugins menu.
7+
Tarvitset työkalun käyttöön käyttäjätunnuksen, jonka voit hakea täältä <http://www.maanmittauslaitos.fi/en/e-services/open-data-file-download-service/open-data-file-updating-service-interface>.
88

9-
**Developed by [Gispo Ltd.](https://www.gispo.fi)**
9+
Aineisto haetaan MML:n ATOM-syötteen kautta, yhdistetään tietyt kohteet karttalehtien välillä ja visualisoidaan peruskarttalehteä muistuttavalla visualisoinnilla.
1010

11-
## Licences
11+
## Description
1212

13-
This plugin utilizes data licensed by Traficom and National Land Survey of Finland. **Please read [nlsgpkgloader/resources/data/LICENCE.md](nlsgpkgloader/resources/data/LICENCE.md) for more information.**
13+
The tool can be found from QGIS official repository <https://plugins.qgis.org/plugins/NLSgpkgloader-master/>
1414

15-
The plugin source code is licensed under GPL v3.0, see [LICENCE](LICENCE).
15+
Download data from the Finnish NLS Atom feed and create a GeoPackage with built-in styles.
1616

17-
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).
17+
This plugin lets users download layers from National Land Survey of Finland's (NLS-FI) topographical database using QGIS3. The data is visualised and dissolved when downloaded to QGIS. The lisence of the data is (CC-BY 4.0). The plugin fetches the NLS-FI Open data file updating service (Atom feed).
18+
19+
Before you can use the tool, you need to order a user-specific identification key from NLS to be able to use this plugin: <http://www.maanmittauslaitos.fi/en/e-services/open-data-file-download-service/open-data-file-updating-service-interface>.
20+
21+
Please report any issues you discover.
1822

19-
## Installation instructions
23+
This plugin is available from the official plugin repository and can be installed from the QGIS Plugins menu.
2024

21-
1. Download the latest release zip from GitHub releases (above) either via Clone or Download ZIP.
25+
**Developed by [Gispo Ltd.](https://www.gispo.fi)**
2226

23-
2. Launch QGIS and navigate to the plugins menu by selecting Plugins - Manage and Install Plugins from the top menu.
27+
<img width="300" alt="Download data dialog" src="documentation/download_data.png">
2428

25-
3. Select the Install from ZIP tab, browse to the zip file you just downloaded, and click Install Plugin!
29+
<img width="500" alt="Project view" src="documentation/project.png">
2630

27-
## Usage
31+
## Usage and installation
2832

29-
Using the plugin is fairly straightforward:
33+
Please read [Instructions.md](nlsgpkgloader/documentation/instructions.md) for more information.
3034

31-
1. Click the NLS plugin icon. Settings window open. Enter a valid identification key (received via email from NLS)
32-
and set the save directory.
33-
2. Another pop-up window, Download Data, opens. If the Settings window did not open as described in step 1, you can
34-
find it by pushing Settings button in the left bottom corner of the Download Data window.
35-
3. Select which areas to download either by picking municipalities / UTM grids / Sea grids from the list or by selecting
36-
features from the map.
37-
4. Choose which layers to write to the GeoPackage. Note that some layers are preselected.
38-
5. Enter a filename. If you wish to load the GeoPackage layers into QGIS, activate Load data check box.
39-
6. Click OK and wait for processing to finish.
35+
## Licences
4036

41-
More documentation, including more detailed installation and usage instructions in Finnish, can be found in the [Wiki](https://github.com/GispoCoding/NLSgpkgloader/wiki).
37+
This plugin utilizes data licensed by Traficom and National Land Survey of Finland. **Please read [nlsgpkgloader/resources/data/LICENCE.md](nlsgpkgloader/resources/data/LICENCE.md) for more information.**
38+
39+
The plugin source code is licensed under GPL v3.0, see [LICENCE](LICENCE).
40+
41+
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).

documentation/download_data.png

21.1 KB
Loading

documentation/instructions.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Installation instructions
2+
3+
The plugin can be found from QGIS official repository: <https://plugins.qgis.org/plugins/NLSgpkgloader-master/>
4+
5+
Go to QGIS 3.X, Plugins and find "NLS GeoPackage Downloader" and install.
6+
7+
<img width="474" alt="Plugin menu" src="plugin.png">
8+
9+
## Usage
10+
11+
Using the plugin is fairly straightforward:
12+
13+
1. Click the NLS plugin icon or go to Plugins/NLS GeoPackage Downloader.
14+
15+
2. First time you use the plugin a Settings window opens. Enter the valid identification key (received via email from NLS)
16+
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.
17+
18+
<img width="248" alt="Settings dialog" src="settings.png">
19+
20+
3. After this another pop-up window, Download Data, opens. If the Settings window did not open as described, you can
21+
find it by pushing Settings button in the left bottom corner of the Download Data window.
22+
23+
<img width="277" alt="Download data dialog" src="download_data.png">
24+
25+
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.
26+
27+
- 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.
28+
29+
<img width="194" alt="Choose layers dialog" src="layers.png">
30+
31+
- If you want the data from a certain municipality, choose the municipality form the list
32+
33+
<img width="194" alt="Choose municipality dialog" src="municipality.png">
34+
35+
- 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.
36+
37+
<img width="583" alt="Choose data from layer" src="seatiles.png">
38+
39+
5. Enter a filename. If you wish to load the GeoPackage layers into QGIS, activate Load data check box.
40+
41+
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.
42+
43+
![ProjectView](project.png)

documentation/layers.png

14.4 KB
Loading

documentation/municipality.png

13.1 KB
Loading

documentation/plugin.png

55.4 KB
Loading

documentation/project.png

509 KB
Loading

documentation/seatiles.png

157 KB
Loading

documentation/settings.png

25.3 KB
Loading

0 commit comments

Comments
 (0)