diff --git a/README.md b/README.md index 848c1fae..dc35ac38 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: @@ -62,25 +62,31 @@ 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...`. -## What's Inside the v2.0.0 download package? +Finally double-click on (or use QGIS open) the `qgreenland.qgs` file that was just +extracted from the zip. -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: + +## What's inside the QGreenland Core zip package? + +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: * `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. 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 diff --git a/doc/citing.md b/doc/citing.md index a9f15d78..8111f8f5 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. A., M. Fisher, T. Stafford, and A. Thurber (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/how-to/troubleshooting.md b/doc/user/how-to/troubleshooting.md index f2f6a0b9..128fab81 100644 --- a/doc/user/how-to/troubleshooting.md +++ b/doc/user/how-to/troubleshooting.md @@ -114,7 +114,22 @@ 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 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. + +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: 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) ``` 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.