Merge pull request #784 from nsidc/switch-to-qgz

Write project file as a .qgz instead of .qgs file
nsidc · Aug 24, 2023 · 89d9098 · 89d9098
2 parents ff2298e + 40eefb0
commit 89d9098
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,11 +1,12 @@
-# v3.0.0 (2023-08-23)
+# v3.0.0 (2023-08-24)
 
-- Resolve `Font "Helvetica" font not available on system` warnings
+- Switch to `.qgz` compressed project file.
+- Resolve `Font "Helvetica" font not available on system` warnings.
 - Update `layer_list.csv` to include new column indicating if each layer is
   stored on disk. Internet-required layers take the value `False`.
-- Configure gradient style legends, add new style validations for gradient legends
-- Fix palletted styles
-- Publish versioned Docker images to DockerHub and GHCR for improved reproducibility
+- Configure gradient style legends, add new style validations for gradient legends.
+- Fix palletted styles.
+- Publish versioned Docker images to DockerHub and GHCR for improved reproducibility.
 
 
 ## :warning: Breaking changes
@@ -16,9 +17,9 @@
 
 ## Documentation
 
-- Restructured documentation for improved readability
-- Added documentation of QGreenland future plans under next NSF grant
-- Improved recommended citations for QGreenland
+- Restructured documentation for improved readability.
+- Added documentation of QGreenland future plans under next NSF grant.
+- Improved recommended citations for QGreenland.
 
 
 ## Layers

diff --git a/doc/_pdf/QuickStartGuide.pdf b/doc/_pdf/QuickStartGuide.pdf
diff --git a/doc/user/how-to/adding-data.md b/doc/user/how-to/adding-data.md
@@ -2,7 +2,7 @@
 
 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`
+QGreenland, or make changes.  Saving the project will update the `qgreenland.qgz`
 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

diff --git a/doc/user/how-to/metadata.md b/doc/user/how-to/metadata.md
@@ -13,7 +13,7 @@ Core](/user/tutorials/03-interacting-with-geospatial-data.md).
 ## 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
+layer metadata within QGIS. First, open the `qgreenland.qgz` 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.

diff --git a/doc/user/how-to/troubleshooting.md b/doc/user/how-to/troubleshooting.md
@@ -32,7 +32,7 @@ If you opened QGreenland from the command line, ensure you got the project name
 correct. E.g., from inside the unzipped QGreenland directory:
 
 ```
-qgis qgreenland.qgs
+qgis qgreenland.qgz
 ```
 
 

diff --git a/doc/user/tutorials/01-get-started.md b/doc/user/tutorials/01-get-started.md
@@ -38,22 +38,20 @@ Ensure QGreenland is _actually_ unzipped; some operating systems will only
 In Windows, please right-click and select `Extract all...`.
 ```
 
-Open the `qgreenland.qgs` file in the data package folder by double-clicking
+Open the `qgreenland.qgz` file in the data package folder by double-clicking
 it. QGIS will open automatically and display the QGreenland Core data
 environment.
 
-
 ```{note}
 Depending on your version of QGreenland Core, the package may be a `.qgs` or a
 `.qgz` file. They should function the same as long as you have a compatible
 version of QGIS.
 ```
 
-
 ```{note}
-If QGIS is already open, one can open the `qgreenland.qgs` project file
+If QGIS is already open, one can open the `qgreenland.qgz` project file
 within QGIS by navigating to the **Project -> Open...** option in the menu bar and
-selecting the `qgreenland.qgs` file from its saved location.
+selecting the `qgreenland.qgz` file from its saved location.
 ```
 
 

diff --git a/doc/what_is_qgr.md b/doc/what_is_qgr.md
@@ -48,7 +48,7 @@ GIS data package for Antarctica.
 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.qgz** - 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

diff --git a/qgreenland/util/luigi/tasks/pipeline.py b/qgreenland/util/luigi/tasks/pipeline.py
@@ -133,11 +133,11 @@ def output(self):
 
     def run(self):
         """Create a symbolic link to trigger the zip."""
-        # make_qgs outputs multiple files, not just one .qgs file. Similar to
+        # make_qgs outputs multiple files, not just one .qgz file. Similar to
         # writing shapefiles, except this time we want to put them inside a
         # pre-existing directory.
         with QgsApplicationContext():
-            make_qgis_project_file(COMPILE_PACKAGE_DIR / "qgreenland.qgs")
+            make_qgis_project_file(COMPILE_PACKAGE_DIR / "qgreenland.qgz")
 
         # Create symbolic link to zip with the final versioned filename
         # We don't _need_ a symbolic link here, but this also serves to trigger