Skip to content

Commit

Permalink
Merge pull request #757 from nsidc/matt-doc-review-howto
Browse files Browse the repository at this point in the history
Update how-tos for v3
  • Loading branch information
mfisher87 authored Aug 23, 2023
2 parents 8eee175 + 2a464ec commit d24faae
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 41 deletions.
15 changes: 7 additions & 8 deletions doc/user/how-to/adding-data.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
# Adding New Datasets to QGreenland

Once the QGreenland Core package is downloaded and extracted onto a user’s
computer, it is fully customizable by the user. One can add new data, delete
layers within QGreenland, or make changes. Saving the project will update the
qgreenland.qgs project file. If you do not want to overwrite the original project
version, simply save your updated project using a new filename via ‘Save As...’
You can create as many different projects as you like, adding or removing data
from the downloaded QGreenland package or adding data from elsewhere on your
computer.
Once the QGreenland Core package is downloaded and extracted onto a user’s computer, it
is fully customizable by the user. One can add new data, delete layers within
QGreenland, or make changes. Saving the project will update the `qgreenland.qgs`
project file. If you do not want to overwrite the original project version, simply save
your updated project using a new filename via **Save As...** You can create as many
different projects as you like, adding or removing data from the downloaded QGreenland
package or adding data from elsewhere on your computer.


```{note}
Expand Down
27 changes: 14 additions & 13 deletions doc/user/how-to/metadata.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# How to Locate Layer Metadata

Metadata refers to the general information about a data file, and the
metadata for QGreenland GIS data files can be accessed in two ways.
metadata for QGreenland layers can be accessed in two ways.

```{note}
For more information on layer properties and metadata, see our Tutorial on
Expand All @@ -12,17 +12,18 @@ Core](/user/tutorials/interacting-with-geospatial-data.md).
(using_qgis)=
## Via QGIS Layer Properties

If you have the QGreenland Core base package downloaded, you can easily locate
and view layer metadata within QGIS. First, open the **qgreenland.qgs** QGIS project file that was included
in the QGreenland Core download package. Next, locate your layer of interest in the **Layer Panel**.
The **Layer Panel** is a panel on the left side of the **Map View** containing a list of layers
that are in your QGIS project.
If you have the QGreenland Core base package downloaded, you can easily locate and view
layer metadata within QGIS. First, open the `qgreenland.qgs` QGIS project file that was
included in the QGreenland Core download package. Next, locate your layer of interest in
the **Layer Panel**. The **Layer Panel** is a panel on the left side of the **Map
View** containing a list of layers that are in your QGIS project.

![layer_panel_2.png](/_images/layer_panel_2.png)

Right click on the layer and select the **Properties** option. This will open the Layer Properties window.
Next, find the metadata tab on the left side window panel. This will show any available information
that is associated with the data layer, including the title and abstract.
Right click on the layer and select the **Properties** option. This will open the Layer
Properties window. Next, find the metadata tab on the left side window panel. This will
show any available information that is associated with the data layer, including the
title and abstract.

![metadata.png](/_images/metadata.png)

Expand All @@ -32,13 +33,13 @@ be found in the **Information** tab.
## Via Text Files in Layer Directories

In each layer directory inside the QGreenland package, you should see 2 text
files, one **provenance.txt**, which includes information on how the data is
processed, and one **metadata.txt**.
files, one `provenance.txt`, which includes information on how the data is
processed, and one `metadata.txt`.

Open up **metadata.txt** to read through the layer metadata including layer
Open up `metadata.txt` to read through the layer metadata including layer
description, dataset abstract, and citation information.

Open the **provenance.txt** file to see all of the processing steps applied to
Open the `provenance.txt` file to see all of the processing steps applied to
the data for QGreenland.

![layer_dir.png](/_images/layer_dir.png)
Expand Down
7 changes: 4 additions & 3 deletions doc/user/how-to/online-layers.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ from QGIS:

## Add a WMS Layer

First, open the “Data Source Manager” from the top **Menu Bar** **(Layer >Data Source
Manager)** and select the “WMS/WMTS” option.
First, open the “Data Source Manager” from the top **Menu Bar** (**Layer -> Data Source
Manager**) and select the “WMS/WMTS” option.

![wms_data_management_screen](/_images/wms_data_management_screen.jpg)

Expand Down Expand Up @@ -79,5 +79,6 @@ layer name in the **Layers Panel**.
![timeseries_layer_clock_icon](/_images/timeseries_layer_clock_icon.png)
**Temporal Layers** can be interacted with using the **Temporal Controller** panel. See the
[QGIS documentation](https://docs.qgis.org/3.28/en/docs/user_manual/map_views/map_view.html#maptimecontrol) for more information about time-based control of the map canvas.
[QGIS documentation](https://docs.qgis.org/3.28/en/docs/user_manual/map_views/map_view.html#maptimecontrol)
for more information about time-based control of the map canvas.
```
19 changes: 8 additions & 11 deletions doc/user/how-to/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,25 +104,20 @@ wish to turn on so that they are displayed. You can also go to

Double-check that there is not another layer overlaying and thus obscuring the
layer you want to see in the **Map View**. Remember that layer are displayed in the
**Map View** in the same order that they are listed in the **Layers Panel - layers**
**Map View** in the same order that they are listed in the **Layers Panel** - layers
listed at the top of the **Layers Panel** show up on top on the **Map View**. You can
either turn off any layer that might be obscuring the layer you wish to see by
unchecking it in the **Layers Panel**, or re-arrange the order of layers by
clicking and dragging them up or down in the **Layers Panel**.

Some QGreenland data layers are only visible at a specific map scale (see
_QGreenland User Guide section 4.3.1: Scale-dependent rendering_ for more
information). Try zooming in.
_QGreenland User Guide section 4.3.1: [Scale-dependent
rendering](#scale-dependent-rendering)_ for more information). Try zooming in.


### When I open QGreenland, I get the warning `Font "Helvetica" not available on system`

This warning indicates that a layer's style requires a font you do not have. This should
not affect your use of QGreenland, as another font will be automatically substituted.

This warning is resolved in QGreenland v3. If you still experience this warning in
QGreenland v3, you need to update QGIS to the minimum supported version 3.28, which is
capable of downloading the needed fonts.
Please upgrade to QGreenland v3 and a supported version of QGIS (>=3.28).

For more context, see the [GitHub
issue](https://github.com/nsidc/qgreenland/issues/515).
Expand Down Expand Up @@ -158,6 +153,8 @@ has determined can be ignored:

## I am having other problems. How do I contact the QGreenland team?

If you have feedback on or questions about the QGreenland data package, or want
to contribute datasets to future QGreenland releases, please contact us at
If you have feedback or questions about the QGreenland data package, or want to
contribute datasets to future QGreenland releases, please participate in our [GitHub
Discussions](https://github.com/nsidc/qgreenland/discussions/) space. If you're
uncomfortable with or otherwise can not participate there, please contact us directly at
<qgreenland.info@gmail.com>.
34 changes: 28 additions & 6 deletions doc/user/tutorials/interacting-with-geospatial-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

There are two main basic kinds of GIS data layers: vector and raster.


### Vector Data

**Vector** data are composed of points, lines, and polygons and represent discrete features.
Expand All @@ -17,6 +18,7 @@ geospatial data.
Fig. 4: Examples of **Vector** data layers in QGreenland Core: Points (towns and settlements), lines
(median January sea ice extent), and polygons (country boundaries).


### Vector Data Attributes

All QGIS vector data layers have associated attributes, or characteristics of the discrete
Expand All @@ -30,6 +32,7 @@ are individual features. Clicking on and highlighting records in the **Attribute
highlight those specific points, lines, or polygons in the **Map View**. Right-click any cell to
‘Zoom to feature’, ‘Pan to feature’, or ‘Flash feature’.


### Raster Data

**Raster** data are composed of grid cells or pixels, where each grid cell has its own value.
Expand Down Expand Up @@ -79,25 +82,31 @@ QGreenland.

Fig. 6: The **Layer Properties** dialog window for the QGreenland ‘Earthquakes’ data layer


## Data Projections

Data projections, or Coordinate Reference Systems (CRS), define the coordinate system for
a QGIS project and data layers. The CRS for the current **Map View** is indicated on the right
side of the QGIS status bar. For QGreenland, the current CRS should be identified as ‘EPSG:
3413,’ which is the identifier for the NSIDC Sea Ice Polar Stereographic North on a WGS 84
Ellipsoid CRS. Changing the CRS of the **Map View** will not change the underlying data, though QGIS will do on-the-fly reprojection of layers not in the selected CRS. It is possible to reproject a layer into a new CRS;
however, this transforms the data and can introduce artifacts. Therefore, it is recommended
that to reproject data, the user do so from the source data and not the data contained in the
QGreenland package.
Ellipsoid CRS. Changing the CRS of the **Map View** will not change the underlying data,
though QGIS will do on-the-fly reprojection of layers not in the selected CRS. It is
possible to reproject a layer into a new CRS; however, this transforms the data and can
introduce artifacts. Therefore, it is recommended that to reproject data, the user do so
from the source data and not the data contained in the QGreenland package.


(scale-dependent-rendering)=
### Scale-Dependent Rendering

Scale-dependent rendering refers to the scale at which a particular data layer will be visible in
the QGIS map display. This can make it easier to zoom in and out for certain data layers. The
user can turn on scale-dependent rendering for any layer by going to the layer **Properties ->
Rendering**, checking the box for Scale Dependent Visibility, and then setting the minimum
user can turn on scale-dependent rendering for any layer by going to the layer **Properties ->
Rendering**, checking the box for Scale Dependent Visibility, and then setting the minimum
and maximum scale dependent visibility. For scale reference, refer to the scale indicated at
the bottom of the QGIS interface in the **Status Bar**.


### QGreenland Data Layers
A complete list of all QGreenland data layers and their metadata, including information about
their original data source, can be found in the layer_list.csv file included in the QGreenland
Expand Down Expand Up @@ -128,6 +137,7 @@ To use the **Identify Features** button:

Fig. 7: The **Identify Results Panel** that shows results from the **Identify Features** tool.


## Measuring Distances, Areas, and Angles

Another useful basic tool in the **Attributes Toolbar** is the **Measuring Tool**. The **Measuring Tool**
Expand All @@ -154,6 +164,7 @@ To use the **Measuring Tool**:
three points to draw the angle. The second point you click on will serve as the
angle’s vertex.


## Adding Text Annotations to the Map View

You can add a text annotation anywhere in the **Map View** using the text annotation tool
Expand All @@ -170,6 +181,7 @@ To use the **Text Annotation Tool**:
5. To delete an annotation, double click on it to open the dialog window, then
click **Delete**.


## Editing Layer Symbology

Each QGreenland data layer comes with a predefined symbology (how the layer is visualized
Expand All @@ -186,6 +198,7 @@ To modify a layer’s symbology:
a raster layer can be changed in the **Transparency** tab of the **Layer Properties**
dialog window.


## Processing Toolbox

The **Processing Toolbox** is what makes the QGIS platform a powerful spatial data analysis tool.
Expand All @@ -200,6 +213,7 @@ view by clicking on the gear icon in the **Attributes Toolbar** or by going to
For more in-depth information about the Processing Toolbox see the
[QGIS User Manual](https://docs.qgis.org/3.28/en/docs/user_manual/processing/toolbox.html)


## Spatial Querying

Spatial querying allows the user to select specific layer features based on desired parameters,
Expand All @@ -210,7 +224,9 @@ learn through experience that there is very often more than one way to complete
task in the QGIS platform. We will describe several query and analysis methodologies that
use the QGIS **Processing Toolbox**.


### Example 1: Selecting from Vector Layers for Specific Features

Which populated regions in Greenland have more than 5000 people?

1. Open the **Processing Toolbox** and go to **Vector selection -> Select by attribute**.
Expand All @@ -235,7 +251,9 @@ you can do so by either 1) right-clicking on the layer you have just selected fr
choosing **Export -> Save selected features as...**, or by 2) selecting **Extract by attribute**
under **Vector selection** in the **Processing Toolbox**.


### Example 2: Vector Layer Statistics

What is the total number of people in Greenland’s populated areas?
What is the average size of Greenland’s populated areas?

Expand All @@ -255,7 +273,9 @@ of people in Greenland’s metropolitan areas (55,494 people).
![vector_layer_stats](/_images/vector_layer_stats.png)
Fig. 8: Results of Example 2: Vector Layer Statistics


### Example 3: Simple Raster Analysis

What is a good estimate of the Greenland ice sheet’s volume?

1. In the **Processing Toolbox**, go to **Raster analysis -> Raster surface volume**. This
Expand All @@ -278,7 +298,9 @@ The results file should contain three numbers: volume, pixel count, and area. Th
the volume of the Greenland ice sheet in units of m3. The results should show that the Green-
land ice sheet has a volume of 2,942,360,633,311,806 m3, or about 2.9 million km3.


### Example 4: Using the Raster Calculator

How does the maximum sea ice concentration (%) around Greenland and
the surrounding land masses in 2020 compare to the maximum sea ice
concentration a decade earlier (2010)?
Expand Down

0 comments on commit d24faae

Please sign in to comment.