From 30f72e6ef27e9643fe06199c87c80697ac2cf95e Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Mon, 31 Jul 2023 16:40:13 -0600 Subject: [PATCH 01/10] Add troubleshooting entry for `Helvetica` issue --- doc/user/how-to/troubleshooting.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/user/how-to/troubleshooting.md b/doc/user/how-to/troubleshooting.md index f2f6a0b9..3dc3e261 100644 --- a/doc/user/how-to/troubleshooting.md +++ b/doc/user/how-to/troubleshooting.md @@ -114,7 +114,23 @@ 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. + +### 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 don't have. This +shouldn't 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. + +For more context, see the [GitHub +issue](https://github.com/nsidc/qgreenland/issues/515). + + ### Navigating QGIS errors + If you are opening QGIS using a terminal or using the QGIS Python console, it is possible you might see one of a few different error messages while using QGIS that the QGreenland team has determined can be ignored: From 558a91e0c8b9255cad731122bbfa9c713511e632 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Mon, 31 Jul 2023 16:42:52 -0600 Subject: [PATCH 02/10] Adjust README for v3 More consistent title formatting, clarify release announcement, clarify "what's inside" section. --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 848c1fae..3331662e 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,12 @@ [Our website](https://www.qgreenland.org) | [Documentation](https://qgreenland.readthedocs.io) > :tada: QGreenland v3 development is well underway. We're looking for testers to -> provide feedback by **August 6, 2023**. Please see our [full -> announcement](https://github.com/nsidc/qgreenland/discussions/694) for more details, -> including highlights of this release. +> provide feedback by **August 6, 2023**. Please see our +> [alpha release announcement](https://github.com/nsidc/qgreenland/discussions/694) +> for more details, including highlights of this release. -## A Free GIS Package for Greenland +## A Free GIS package for Greenland QGreenland is a free mapping tool to support interdisciplinary Greenland-focused research, teaching, decision making, and collaboration. @@ -48,7 +48,7 @@ on any transformations. All QGreenland GeoPackages and GeoTIFFs are projected in `EPSG:3413`. -# Getting Started +# Getting started As of this writing, the oldest version of QGIS we support for the QGreenland release series are: @@ -65,22 +65,22 @@ and unzip it with your unzip tool of choice if you haven not already done so. Finally, open the `qgreenland.qgs` file contained inside with QGIS. -## What's Inside the v2.0.0 download package? +## What's inside the download package? -At the root of the package, you will find scientific discipline-specific -directories containing data. Additionally, the following files are present at -the package root: +At the root of the package, you will find scientific discipline-specific directories +containing data (GeoTIFFs and GeoPackages). Additionally, the following files are +present at the package root: * `UserGuide.pdf`: Detailed user-guide. * `QuickStartGuide.pdf`: Guide for QGIS beginners. * `README.html`: The README file you are currently reading. * `CHANGELOG.html`: A summary of changes for each new QGreenland version. * `layer_list.csv`: Comma-separated values representing the configuration of - layers in QGreenland. This includes limited layer metadata, including, but - not limited to: title, description, abstract, and citation. + layers in QGreenland. This includes limited layer metadata, including, but not limited + to: title, description, abstract, and citation. -# Educational Resources +# Educational resources We keep the QGreenland official website up-to-date with links to helpful educational resources, including our own QGreenland User Guide. From a8617cac809989c0796fb267ac06047a8ba172b8 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Mon, 31 Jul 2023 16:48:54 -0600 Subject: [PATCH 03/10] Update "What is QGreenland" doc page for v3 --- doc/what_is_qgr.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/doc/what_is_qgr.md b/doc/what_is_qgr.md index 962c2066..e9add337 100644 --- a/doc/what_is_qgr.md +++ b/doc/what_is_qgr.md @@ -21,9 +21,9 @@ delivered in two ways: different direction. It shouldn't be expected to work. ``` - Return to [QGreenland website](https://qgreenland.org) + # What QGreenland *is not* * The QGreenland project is not a data-production project. While we do @@ -49,9 +49,10 @@ GIS data package for Antarctica. # QGreenland Core Download Package -You will find the following files in the v2.0.0 QGreenland Core data package: -* Folders containing data layers organized by topic -* The main **qgreenland.qgs** project file +You will find the following files in the QGreenland Core data package: +* Folders containing data layers organized by topic. Each data layer is represented as a + GeoTIFF or GeoPackage. +* **qgreenland.qgs** - The main QGreenland project file for QGIS * **qgreenland.png** - The official QGreenland logo * **layer_list.csv** - A complete list of all the data layers in the QGreenland Core download package, including information about each (data source, file size, etc.). This file can be @@ -63,13 +64,14 @@ You will find the following files in the v2.0.0 QGreenland Core data package: * **README.txt** - Brief description of the QGreenland data package * **CHANGELOG.txt** - A log of changes made to the QGreenland data package - -Please note that QGreenland Core v1.0.0 is the first stable public release version from this project. -The QGreenland Core v2.0.0 download package was released in March 2022. -Development versions along the way will continue to be available via the -[website](http://qgreenland.org), with code fully documented on +Please note that QGreenland Core v1.0.0 is the first stable public release version from +this project. The QGreenland Core v2.0.0 download package was released in March 2022. +The QGreenland Core v3.0.0 download package was released in August 2023. Development +versions along the way will continue to be available via the +[website](http://qgreenland.org), with code fully documented on [GitHub](https://github.com/nsidc/qgreenland). -Although the v2.0.0 download package contains a full User Guide, updates and additions are constantly -being made to our documentation as we continue to develop QGreenland. -The most recent version of QGreenland documentation will always be available here on Read the Docs. +Although the v3.0.0 download package contains a full User Guide, updates and additions +are constantly being made to our documentation as we continue to develop QGreenland. +The most recent version of QGreenland documentation will always be available here on +Read the Docs. From 9d804979efe533928d767f9378b1652f48446868 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Mon, 31 Jul 2023 18:04:48 -0600 Subject: [PATCH 04/10] Add new citation, clarify some v2 prose --- doc/citing.md | 25 +++++++++++++++------ doc/user/tutorials/get-started.md | 2 +- doc/user/tutorials/video-series-overview.md | 9 ++++++-- 3 files changed, 26 insertions(+), 10 deletions(-) diff --git a/doc/citing.md b/doc/citing.md index a9f15d78..cdc2cbdb 100644 --- a/doc/citing.md +++ b/doc/citing.md @@ -28,14 +28,25 @@ acknowledge or cite QGreenland and the National Snow and Ice Data Center in your Suggested citations for QGreenland: -Version 1.0: -Moon, T., Fisher, M., Harden, L., and T. Stafford (2021). QGreenland (v1.0.0) [software], -[National Snow and Ice Data Center](https://qgreenland.org/). -Version 2.0: -Moon, T., Fisher, M., Harden, L., Simonoko, H., and T. Stafford (2022). QGreenland (v2.0.0) [software], -[National Snow and Ice Data Center](https://qgreenland.org/). +### Version 1.0 + +> Moon, T., Fisher, M., Harden, L., and T. Stafford (2021). QGreenland (v1.0.0) [software], +> [National Snow and Ice Data Center](https://qgreenland.org/). + + +### Version 2.0 + +> Moon, T., Fisher, M., Harden, L., Simonoko, H., and T. Stafford (2022). QGreenland (v2.0.0) [software], +> [National Snow and Ice Data Center](https://qgreenland.org/). + + +### Version 3.0 + +> Moon, T., Fisher, M., Thurber, A., and T. Stafford (2023). QGreenland (v3.0.0) [software], +> [National Snow and Ice Data Center](https://qgreenland.org/). + ## Acknowledgement -We acknowledge the National Snow and Ice Data Center QGreenland package. +> We acknowledge the National Snow and Ice Data Center QGreenland package. diff --git a/doc/user/tutorials/get-started.md b/doc/user/tutorials/get-started.md index 81fa330d..82f89d51 100644 --- a/doc/user/tutorials/get-started.md +++ b/doc/user/tutorials/get-started.md @@ -18,7 +18,7 @@ the long term release (3.16 or later) version. ## 2) Download and open the QGreenland Core package -Download the QGreenland Core data package (v2.0.0) at +Download the QGreenland Core data package (v3.0.0) at [https://qgreenland.org/download](https://qgreenland.org/download). Save the zip package to a location of your choice and unzip it. Open the diff --git a/doc/user/tutorials/video-series-overview.md b/doc/user/tutorials/video-series-overview.md index 1eb26677..719a49e9 100644 --- a/doc/user/tutorials/video-series-overview.md +++ b/doc/user/tutorials/video-series-overview.md @@ -58,13 +58,18 @@ If you are not familiar with geographic information systems (GIS) and geospatial - Calculate the surface volume area of a raster layer ```{note} -In our example, ‘select by attribute’ for a population greater than 5000 would only work on an integer field. In v2.0, the population size field is a text string and you will first need to use the field calculator to convert the population field into an integer. To do so: +In our example, ‘select by attribute’ for a population greater than 5000 would only work +on an integer field. In v2.0 and later, the population size field is a text string and +you will first need to use the field calculator to convert the population field into an +integer. To do so: 1. Open up the attribute table, and click the ‘Open field calculator’ icon. ![OpenFieldcalculator_Larger](/_images/OpenFieldcalculator_Larger.png) -2. Check ‘Create a new field’. Designate an output field name (example: pop_numeric) and select the output field type ‘Integer (32 bit)’. In the expression panel, choose the field ‘population’. Click OK. +2. Check ‘Create a new field’. Designate an output field name (example: pop_numeric) and + select the output field type ‘Integer (32 bit)’. In the expression panel, choose the + field ‘population’. Click OK. ![create_new_field](/_images/create_new_field.png) ``` From 841acc8ba15a6e75dc33d880e6eb06516714b048 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Mon, 31 Jul 2023 18:06:00 -0600 Subject: [PATCH 05/10] Update acknowledgements --- doc/acknowledgements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/acknowledgements.md b/doc/acknowledgements.md index c4750bdd..624c5a06 100644 --- a/doc/acknowledgements.md +++ b/doc/acknowledgements.md @@ -14,7 +14,7 @@ package creation. Thank you! The U.S. National Science Foundation [grant \#1928393](https://nsf.gov/awardsearch/showAward?AWD_ID=1928393) funded the -development of QGreenland versions `1.x` and `2.x`. Thank you! +development of QGreenland versions `1.x`, `2.x`, and `3.x`. Thank you! ## Editorial board From c53f5f92654ae8daf7def2ce5fbe0f02af5d3159 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 1 Aug 2023 09:11:39 -0600 Subject: [PATCH 06/10] Un-apostrophize --- doc/user/how-to/troubleshooting.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/user/how-to/troubleshooting.md b/doc/user/how-to/troubleshooting.md index 3dc3e261..128fab81 100644 --- a/doc/user/how-to/troubleshooting.md +++ b/doc/user/how-to/troubleshooting.md @@ -117,9 +117,8 @@ 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 don't have. This -shouldn't affect your use of QGreenland, as another font will be automatically -substituted. +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 From 05e71c543d05f4778a29155fa683d30bd9627bfe Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 1 Aug 2023 10:43:47 -0600 Subject: [PATCH 07/10] Use more specific language in README to refer to QGreenland Core --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3331662e..3bae042f 100644 --- a/README.md +++ b/README.md @@ -65,9 +65,9 @@ and unzip it with your unzip tool of choice if you haven not already done so. Finally, open the `qgreenland.qgs` file contained inside with QGIS. -## What's inside the download package? +## What's inside the QGreenland Core zip package? -At the root of the package, you will find scientific discipline-specific directories +At the root of the zip file, you will find scientific discipline-specific directories containing data (GeoTIFFs and GeoPackages). Additionally, the following files are present at the package root: From d6b8571bc816893381cf21f898969edd179a0970 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 1 Aug 2023 10:44:58 -0600 Subject: [PATCH 08/10] Add warning about OSes that "explore" zips by default --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3bae042f..dc35ac38 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,13 @@ You can find downloads and instructions After installing QGIS, [download QGreenland](https://qgreenland.org/download) and unzip it with your unzip tool of choice if you haven not already done so. -Finally, open the `qgreenland.qgs` file contained inside with QGIS. + +> :warning: Ensure QGreenland is _actually_ unzipped; some operating systems will only +> "explore" a zip file when you double-click it without actually extracting it to disk. +> In Windows, please right-click and select `Extract all...`. + +Finally double-click on (or use QGIS open) the `qgreenland.qgs` file that was just +extracted from the zip. ## What's inside the QGreenland Core zip package? From 47d7ff16ddfb8f459a34547390c7717795dbe710 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 1 Aug 2023 10:46:21 -0600 Subject: [PATCH 09/10] Fix alphabetization error --- doc/citing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/citing.md b/doc/citing.md index cdc2cbdb..88c89330 100644 --- a/doc/citing.md +++ b/doc/citing.md @@ -43,7 +43,7 @@ Suggested citations for QGreenland: ### Version 3.0 -> Moon, T., Fisher, M., Thurber, A., and T. Stafford (2023). QGreenland (v3.0.0) [software], +> Moon, T., Fisher, M., Stafford, T., and A. Thurber (2023). QGreenland (v3.0.0) [software], > [National Snow and Ice Data Center](https://qgreenland.org/). From ebf05b30cec4124731ff7c1781354909c6dd9af1 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 1 Aug 2023 10:49:02 -0600 Subject: [PATCH 10/10] Fix citation formatting issues --- doc/citing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/citing.md b/doc/citing.md index 88c89330..8111f8f5 100644 --- a/doc/citing.md +++ b/doc/citing.md @@ -43,7 +43,7 @@ Suggested citations for QGreenland: ### Version 3.0 -> Moon, T., Fisher, M., Stafford, T., and A. Thurber (2023). QGreenland (v3.0.0) [software], +> Moon, T. A., M. Fisher, T. Stafford, and A. Thurber (2023). QGreenland (v3.0.0) [software], > [National Snow and Ice Data Center](https://qgreenland.org/).