Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/datasets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ The following table lists available datasets, their DOI, and provides links to s
- Not Applicable (N/A)
- 4326
- 10.1002/2013MS000293
* - 8
- Generic TIF Files
- Any
- Any
- Multiple


---------------------
Expand All @@ -75,4 +80,5 @@ Detailed Descriptions
scripts/modis.rst
scripts/soil_class.rst
scripts/soil_grids.rst
scripts/generic-tif.rst

3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,15 +117,16 @@ documentation!
:maxdepth: 2
:caption: User Manual

index
quick_start
json

.. toctree::
:maxdepth: 3
:caption: Datasets

datasets

.. toctree::
:maxdepth: 1
:caption: License

Expand Down
92 changes: 92 additions & 0 deletions docs/scripts/generic-tif.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
``generic-tif`` Geospatial Dataset
==================================

In this file, the necessary technical details of the dataset is
explained.

Location of the ``generic-tif`` Dataset Files
---------------------------------------------

This dataset can process any GeoTIFF file and is designed to handle
those data bases without any specific structure. Current datasets that
can be processed by this recipe along with their HPC locations are
listed below. These paths can be used as values for the
``--dataset-dir`` argument:

.. code:: console

# UCalgary ARC Cluster
/work/comphyd_lab/data/geospatial-data/hawaii_dem/3mDEM # High resolution Hawaii DEM
/work/comphyd_lab/data/geospatial-data/iceland_dem # High resolution Iceland DEM
/work/comphyd_lab/data/geospatial-data/baker_creek_dem # High resolution Baker Creek DEM
/work/comphyd_lab/data/geospatial-data/wolf_creek_dem # High resolution Wolf Creek DEM
/work/comphyd_lab/data/geospatial-data/marmot_creek_dem # High resolution Marmot Creek DEM

Dataset Variables
-----------------

This variables of this dataset are detailed in the table below:

+---+-----------+-----------------------------+---------------------+----------+
| # | Dataset | Variable Name(s) (value for | Description | Comments |
| | Directory | ``--variables``) | | |
+===+===========+=============================+=====================+==========+
| 1 | Hawaii | ``Big_Island.tif``, | High-resolution DEM | [1]_ |
| | DEM | ``Kahoolawe.tif``, | of Hawaii islands | |
| | | ``Kauai_Puuwai.tif``, | | |
| | | ``Lanai.tif``, | | |
| | | ``Maui.tif``, | | |
| | | ``Molokai.tif``, | | |
| | | ``Oahu.tif`` | | |
+---+-----------+-----------------------------+---------------------+----------+
| 2 | Iceland | ``merged_iceland_dem.tif`` | High-resolution DEM | [2]_ |
| | DEM | | of Iceland | |
+---+-----------+-----------------------------+---------------------+----------+
| 3 | Baker | ``baker-creek-10m-DEM.tif`` | 10-m LiDAR DEM of | [3]_ |
| | Creek DEM | | the Baker Creek | |
| | | | River Basin, NWT, | |
| | | | Canada | |
+---+-----------+-----------------------------+---------------------+----------+
| 4 | Wolf | ``wolf-creek-30m-DEM.tif`` | 30-m LiDAR DEM of | [4]_ |
| | Creek DEM | | the Wolf Creek | |
| | | | River Basin, YT, | |
| | | | Canada | |
+---+-----------+-----------------------------+---------------------+----------+
| 5 | Marmot | ``marmot-creek-8m-DEM.tif`` | 8-m LiDAR DEM of | [5]_ |
| | Creek DEM | | the Marmot Creek | |
| | | | River Basin, AB, | |
| | | | Canada | |
+---+-----------+-----------------------------+---------------------+----------+

.. [1]
NOAA National Centers for Environmental Information (NCEI). (2021).
Continuously Updated Digital Elevation Model (CUDEM) – Ninth
Arc-Second Resolution Bathymetric-Topographic Tiles: Hawaii Data set
(Tile Cluster 9428; fileIdentifier gov.noaa.ngdc.mgg.dem:299919).
NOAA. Retrieved September 12, 2024, from
https://noaa-nos-coastal-lidar-pds.s3.amazonaws.com/dem/NCEI_ninth_Topobathy_Hawaii_9428/index.html

.. [2]
National Land Survey of Iceland (Landmælingar Íslands). (2016).
ÍslandsDEM v1.0 [Digital Elevation Model of Iceland, 10 m
resolution]. License: CC BY 4.0. Available at
https://atlas.lmi.is/dem or
https://dem.lmi.is/mapview/?application=DEM.

.. [3]
Spence, C., Hedstrom, N. (2018). Baker Creek Research Catchment
Hydrometeorological and Hydrological Data. Federated Research Data
Repository. https://doi.org/10.20383/101.026

.. [4]
Rasouli, K., Pomeroy, J. W., Janowicz, J. R., Williams, T. J., &
Carey, S. K. (2019). A long-term hydrometeorological dataset
(1993–2014) of a northern mountain basin: Wolf Creek Research Basin,
Yukon Territory, Canada. Earth System Science Data, 11(1), 89-100,
https://doi.org/10.5194/essd-11-89-2019

.. [5]
Fang, X., Pomeroy, J. W., DeBeer, C. M., Harder, P., and Siemens, E.
(2019). Hydrometeorological data from Marmot Creek Research Basin,
Canadian Rockies. Earth Syst. Sci. Data, 11, 455–471,
https://doi.org/10.5194/essd-11-455-2019.
6 changes: 5 additions & 1 deletion extract-gis.sh
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Script options:
must be comma delimited float numbers between
0 and 1; optional [defaults to every 5th quantile]
-p, --prefix=STR Prefix prepended to the output files
-b, --parsable Parsable SLURM message mainly used
-b, --parsable Parsable scheduler message mainly used
for chained job submissions
-c, --cache=DIR Path of the cache directory; optional
-E, --email=STR E-mail when job starts, ends, and fails; optional
Expand Down Expand Up @@ -616,6 +616,10 @@ case "${geotiff,,}" in
call_processing_func "$recipePath/nhm/nhm.sh"
;;

"generic-tif" | "generic_tif" | "tif" | "tiff" )
call_processing_func "$recipePath/generic_tif/generic_tif.sh"
;;

# dataset not included above
*)
echo "$(basename $0): missing/unknown dataset";
Expand Down
35 changes: 35 additions & 0 deletions var/repos/builtin/recipes/generic_tif/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# `generic-tif` Geospatial Dataset
In this file, the necessary technical details of the dataset is explained.

## Location of the `generic-tif` Dataset Files
This dataset can process any GeoTIFF file and is designed to handle those
data bases without any specific structure. Current datasets that can be
processed by this recipe along with their HPC locations are listed below.
These paths can be used as values for the `--dataset-dir` argument:

```console
# UCalgary ARC Cluster
/work/comphyd_lab/data/geospatial-data/hawaii_dem/3mDEM # High resolution Hawaii DEM
/work/comphyd_lab/data/geospatial-data/iceland_dem # High resolution Iceland DEM
/work/comphyd_lab/data/geospatial-data/baker_creek_dem # High resolution Baker Creek DEM
/work/comphyd_lab/data/geospatial-data/wolf_creek_dem # High resolution Wolf Creek DEM
/work/comphyd_lab/data/geospatial-data/marmot_creek_dem # High resolution Marmot Creek DEM
```

## Dataset Variables
This variables of this dataset are detailed in the table below:

|# |Dataset Directory| Variable Name(s) (value for `--variables`) |Description |Comments |
|-------|-----------------|----------------------------------------------|---------------------------------------|---------------|
|1 |Hawaii DEM |`Big_Island.tif`, `Kahoolawe.tif`, `Kauai_Puuwai.tif`, `Lanai.tif`, `Maui.tif`, `Molokai.tif`, `Oahu.tif`|High-resolution DEM of Hawaii islands|[^1] |
|2 |Iceland DEM |`merged_iceland_dem.tif` |High-resolution DEM of Iceland |[^2] |
|3 |Baker Creek DEM |`baker-creek-10m-DEM.tif` |10-m LiDAR DEM of the Baker Creek River Basin, NWT, Canada|[^3]|
|4 |Wolf Creek DEM |`wolf-creek-30m-DEM.tif` |30-m LiDAR DEM of the Wolf Creek River Basin, YT, Canada|[^4]|
|5 |Marmot Creek DEM |`marmot-creek-8m-DEM.tif` |8-m LiDAR DEM of the Marmot Creek River Basin, AB, Canada|[^5]|


[^1]: NOAA National Centers for Environmental Information (NCEI). (2021). Continuously Updated Digital Elevation Model (CUDEM) – Ninth Arc-Second Resolution Bathymetric-Topographic Tiles: Hawaii Data set (Tile Cluster 9428; fileIdentifier gov.noaa.ngdc.mgg.dem:299919). NOAA. Retrieved September 12, 2024, from https://noaa-nos-coastal-lidar-pds.s3.amazonaws.com/dem/NCEI_ninth_Topobathy_Hawaii_9428/index.html
[^2]: National Land Survey of Iceland (Landmælingar Íslands). (2016). ÍslandsDEM v1.0 [Digital Elevation Model of Iceland, 10 m resolution]. License: CC BY 4.0. Available at https://atlas.lmi.is/dem or https://dem.lmi.is/mapview/?application=DEM.
[^3]: Spence, C., Hedstrom, N. (2018). Baker Creek Research Catchment Hydrometeorological and Hydrological Data. Federated Research Data Repository. https://doi.org/10.20383/101.026
[^4]: Rasouli, K., Pomeroy, J. W., Janowicz, J. R., Williams, T. J., & Carey, S. K. (2019). A long-term hydrometeorological dataset (1993–2014) of a northern mountain basin: Wolf Creek Research Basin, Yukon Territory, Canada. Earth System Science Data, 11(1), 89-100, https://doi.org/10.5194/essd-11-89-2019
[^5]: Fang, X., Pomeroy, J. W., DeBeer, C. M., Harder, P., and Siemens, E. (2019). Hydrometeorological data from Marmot Creek Research Basin, Canadian Rockies. Earth Syst. Sci. Data, 11, 455–471, https://doi.org/10.5194/essd-11-455-2019.
Loading