Skip to content

Commit

Permalink
Updates on readme and new instructions (#33)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
SannaJokela and ismogis authored Dec 15, 2023
1 parent 2a4e34b commit 43999b1
Show file tree
Hide file tree
Showing 9 changed files with 67 additions and 24 deletions.
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,41 @@
# NLS GeoPackage Downloader QGIS plugin

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.
## Shortly in Finnish

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

This plugin is available from the official plugin repository and can be installed from the QGIS Plugins menu.
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>.

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

## Licences
## Description

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.**
The tool can be found from QGIS official repository <https://plugins.qgis.org/plugins/NLSgpkgloader-master/>

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

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).
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).

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>.

Please report any issues you discover.

## Installation instructions
This plugin is available from the official plugin repository and can be installed from the QGIS Plugins menu.

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

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

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

## Usage
## Usage and installation

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

1. Click the NLS plugin icon. Settings window open. Enter a valid identification key (received via email from NLS)
and set the save directory.
2. Another pop-up window, Download Data, opens. If the Settings window did not open as described in step 1, you can
find it by pushing Settings button in the left bottom corner of the Download Data window.
3. Select which areas to download either by picking municipalities / UTM grids / Sea grids from the list or by selecting
features from the map.
4. Choose which layers to write to the GeoPackage. Note that some layers are preselected.
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.
## Licences

More documentation, including more detailed installation and usage instructions in Finnish, can be found in the [Wiki](https://github.com/GispoCoding/NLSgpkgloader/wiki).
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.**

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).
Binary file added documentation/download_data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions documentation/instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## 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="Plugin menu" src="plugin.png">

## 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="Settings dialog" src="settings.png">

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="Download data dialog" src="download_data.png">

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="Choose layers dialog" src="layers.png">

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

<img width="194" alt="Choose municipality dialog" src="municipality.png">

- 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="Choose data from layer" src="seatiles.png">

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.

![ProjectView](project.png)
Binary file added documentation/layers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/municipality.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/plugin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/seatiles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 43999b1

Please sign in to comment.