Geoprocessing SNODAS state variables
Reference: https://nsidc.org/sites/nsidc.org/files/G02158-V001-UserGuide_2.pdf
cold_content(translated_tif)
Compute cold content as a function of SWE and snow pack avg temp
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
translated_tif |
dict
|
"product_code": { "filetype": str, Matching database acquirable "file": str, Converted file "datetime": str, Valid Time, ISO format with timezone "version": str Reference Time (forecast), ISO format with timezone } |
required |
Returns:
| Type | Description |
|---|---|
dict
|
{ "filetype": str, Matching database acquirable "file": str, Converted file "datetime": str, Valid Time, ISO format with timezone "version": str Reference Time (forecast), ISO format with timezone } |
Source code in cumulus_geoproc/geoprocess/snodas/__init__.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | |
no_data_value(dt)
No data value determined by time
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dt |
datetime
|
datetime object |
required |
Returns:
| Type | Description |
|---|---|
int
|
raster no data value |
Source code in cumulus_geoproc/geoprocess/snodas/__init__.py
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 | |
snow_melt_mm(translated_tif)
Dictionary of tiffs generated from gdal translate
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
translated_tif |
dict
|
"product_code": { "filetype": str, Matching database acquirable "file": str, Converted file "datetime": str, Valid Time, ISO format with timezone "version": str Reference Time (forecast), ISO format with timezone } |
required |
Returns:
| Type | Description |
|---|---|
dict
|
{ "filetype": str, Matching database acquirable "file": str, Converted file "datetime": str, Valid Time, ISO format with timezone "version": str Reference Time (forecast), ISO format with timezone } |
Source code in cumulus_geoproc/geoprocess/snodas/__init__.py
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | |
SNODAS interpolation
is_lakefix(dt, code)
Determine if needing 'lakefix'
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dt |
datetime
|
datetime object |
required |
code |
str
|
parameter code related to SNODAS parameters |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True | False if needing 'lakefix' |
Source code in cumulus_geoproc/geoprocess/snodas/interpolate.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | |
snodas(cfg, dst)
async
Main method building asyncio tasks
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cfg |
namedtuple
|
namedtuple with SQS message as attributes |
required |
dst |
str
|
FQPN to temporary directory |
required |
Returns:
| Type | Description |
|---|---|
List[dict[str, str]]
|
List of dictionary objects with attributes needed to upload to S3 |
Source code in cumulus_geoproc/geoprocess/snodas/interpolate.py
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 | |
snodas_interp_task(filepath, product, dt, max_dist, nodata, lakefix=False)
async
SNODAS interpolation task method used with asyncio
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filepath |
str
|
FQPN to processed SNODAS COG |
required |
product |
str
|
Cumulus product name |
required |
dt |
datetime
|
datetime object |
required |
max_dist |
str
|
maximum distance in pixel for gdal_fillnodata |
required |
nodata |
str
|
raster no data value |
required |
lakefix |
bool, optional
|
determine if product needs 'lakefix', by default False |
False
|
Returns:
| Type | Description |
|---|---|
dict[str, str] | None
|
Dictionary of attributes needed to upload to S3 or None |
Source code in cumulus_geoproc/geoprocess/snodas/interpolate.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | |
Metadata parser
to_dictionary(src)
ASCII input from SNODAS metadata to a dictionary
all keys are psuedo-slugified
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src |
str
|
SNODAS metadata as .txt |
required |
Returns:
| Type | Description |
|---|---|
dict | None
|
dictionary of metadata parameters and their values or None |
Source code in cumulus_geoproc/geoprocess/snodas/metaparse.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | |
to_namedtuple(src, name='Metadata')
Use to_dictionary to generate a namedtuple
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src |
str
|
SNODAS metadata as .txt |
required |
name |
str, optional
|
collections.namedtuple name, by default "Metadata" |
'Metadata'
|
Returns:
| Type | Description |
|---|---|
collections.namedtuple
|
namedtuple |
Source code in cumulus_geoproc/geoprocess/snodas/metaparse.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | |
write_hdr(src, /, columns, rows)
Write a header file (hdr)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src |
str
|
SNODAS metadata as .txt |
required |
columns |
int
|
number of columns from the metadata text file |
required |
rows |
int
|
number of rows from the metadata text file |
required |
Returns:
| Type | Description |
|---|---|
str
|
FQPN to the written hdr file | None |
Source code in cumulus_geoproc/geoprocess/snodas/metaparse.py
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | |