shachen 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
shachen-0.1.0/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
shachen-0.1.0/NOTICE ADDED
@@ -0,0 +1,16 @@
1
+ shachen
2
+ Copyright 2026 Han Xiao
3
+
4
+ This product includes an independent implementation of the DEBRA-Dust
5
+ algorithm described in:
6
+
7
+ Miller, S. D., Bankert, R. L., Grasso, L. D., Lindsey, D. T., Kuciauskas,
8
+ A. P., & Combs, C. L. (2017). A dynamic enhancement with background
9
+ reduction algorithm: Overview and application to satellite-based dust storm
10
+ detection. Journal of Geophysical Research: Atmospheres, 122, 12,938-12,959.
11
+ https://doi.org/10.1002/2017JD027365
12
+
13
+ Equations follow the erratum published 26 February 2020.
14
+
15
+ The paper is not distributed with this software. This implementation is not
16
+ produced, endorsed, or verified by the paper's authors, by CIRA, or by NOAA.
shachen-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,180 @@
1
+ Metadata-Version: 2.4
2
+ Name: shachen
3
+ Version: 0.1.0
4
+ Summary: Infrared satellite dust storm detection — an open implementation of the DEBRA-Dust algorithm for GOES ABI and Himawari AHI
5
+ Keywords: dust,dust-storm,sand-dust,DEBRA,satellite,remote-sensing,infrared,split-window,aerosol,GOES,ABI,Himawari,AHI,atmospheric-science
6
+ Author: Han Xiao
7
+ Author-email: Han Xiao <ringsaturn.me@gmail.com>
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE
10
+ License-File: NOTICE
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
17
+ Classifier: Topic :: Scientific/Engineering :: Image Processing
18
+ Requires-Dist: global-land-mask>=1.0.0
19
+ Requires-Dist: numpy>=2.5.2
20
+ Requires-Dist: pyorbital>=1.12.1
21
+ Requires-Dist: pyresample>=1.35.0
22
+ Requires-Dist: scipy>=1.18.1
23
+ Requires-Dist: xarray>=2026.7.0
24
+ Requires-Dist: shachen[satellite,data,render] ; extra == 'all'
25
+ Requires-Dist: earthaccess>=0.18.0 ; extra == 'data'
26
+ Requires-Dist: netcdf4>=1.7.4 ; extra == 'data'
27
+ Requires-Dist: s3fs>=2026.7.0 ; extra == 'data'
28
+ Requires-Dist: cartopy>=0.25.0 ; extra == 'render'
29
+ Requires-Dist: matplotlib>=3.11.1 ; extra == 'render'
30
+ Requires-Dist: satpy>=0.45 ; extra == 'satellite'
31
+ Requires-Dist: dask>=2026.7.1 ; extra == 'satellite'
32
+ Requires-Dist: netcdf4>=1.7.4 ; extra == 'satellite'
33
+ Requires-Python: >=3.12
34
+ Project-URL: Homepage, https://github.com/ringsaturn/shachen
35
+ Project-URL: Repository, https://github.com/ringsaturn/shachen
36
+ Project-URL: Issues, https://github.com/ringsaturn/shachen/issues
37
+ Project-URL: Paper, https://doi.org/10.1002/2017JD027365
38
+ Provides-Extra: all
39
+ Provides-Extra: data
40
+ Provides-Extra: render
41
+ Provides-Extra: satellite
42
+ Description-Content-Type: text/markdown
43
+
44
+ # shachen (沙尘)
45
+
46
+ Infrared satellite **dust storm detection** in Python — an open implementation
47
+ of **DEBRA-Dust**, the Dynamic Enhancement with Background Reduction Algorithm
48
+ (Miller et al. 2017, [doi:10.1002/2017JD027365](https://doi.org/10.1002/2017JD027365)),
49
+ for GOES ABI and Himawari AHI.
50
+
51
+ *shachen* (沙尘) is Chinese for "sand and dust". The package is a home for
52
+ infrared-channel dust algorithms; DEBRA-Dust is the first one.
53
+
54
+ This appears to be the first public implementation of DEBRA.
55
+
56
+ > **All equations follow the erratum published 26 February 2020**, not the
57
+ > figures as originally printed.
58
+
59
+ ![DEBRA-Dust enhanced imagery from GOES-16 ABI and Himawari-8 AHI](docs/img/dust-cases.png)
60
+
61
+ Dust is the yellow modulation; everything else stays in greyscale infrared.
62
+ Left is the case from the paper's Figure 6. Both panels come straight out of
63
+ `scripts/run_case.py`, one per sensor.
64
+
65
+ ## What it does
66
+
67
+ DEBRA turns the split-window infrared signal that is specific to *mineral*
68
+ dust into a per-pixel confidence field, by comparing each pixel against a
69
+ dynamically estimated **clear-sky background** rather than a fixed threshold.
70
+ That background is what lets it work over bright, emissivity-heterogeneous
71
+ desert surfaces where fixed thresholds produce false alarms.
72
+
73
+ ```
74
+ io.satellite.load_scene L1b → bt_* / refl_* on the 2 km fixed grid (satpy)
75
+
76
+
77
+ pipeline.run_debra
78
+ ├─ geo.regrid_latlon MERRA-2 / CAMEL → satellite grid
79
+ ├─ solar per-pixel solar zenith (day / twilight / night mix)
80
+ ├─ background scheme A: CAMEL emissivity × Planck(MERRA-2 skin T)
81
+ │ or composite scheme B: 14-day cloud-cleared same-hour composite
82
+ ├─ cloudmask Eqs. 1–12, including the dust restoral term
83
+ ├─ dust_tests DT1–DT3, Eqs. 13–15, normalised per-pixel
84
+ ├─ confidence Eqs. 16–22 → cf_comb
85
+ ├─ imagery Eqs. 23–29, CF-modulated RGB
86
+ └─ render georeferenced PNG with coastlines (cartopy)
87
+ ```
88
+
89
+ Only one background scheme is used at a time: `run_debra` requires exactly one
90
+ of `emissivity=` or `background=`. The composite scheme carries the
91
+ split-window water-vapour depression that the semi-analytic one lacks.
92
+
93
+ ## Documentation
94
+
95
+ **<https://ringsaturn.github.io/shachen/>** — user guide, all 29 equations as
96
+ implemented, full API reference, and the deviations page.
97
+
98
+ ```sh
99
+ make -C docs html # → docs/_build/html/index.html
100
+ make -C docs latexpdf # → docs/_build/latex/shachen.pdf (needs a TeX install)
101
+ ```
102
+
103
+ ## Install
104
+
105
+ The core install is small — it runs the entire algorithm on fields you already
106
+ have in memory, and pulls in no I/O or plotting stack:
107
+
108
+ ```sh
109
+ pip install shachen
110
+ ```
111
+
112
+ Add what you need on top:
113
+
114
+ ```sh
115
+ pip install "shachen[satellite]" # satpy: read and calibrate ABI/AHI L1b
116
+ pip install "shachen[data]" # earthaccess/s3fs: fetch MERRA-2, CAMEL, L1b
117
+ pip install "shachen[render]" # cartopy/matplotlib: georeferenced PNG
118
+ pip install "shachen[all]" # everything, for the reproduction scripts
119
+ ```
120
+
121
+ `import shachen` pulls in none of the extras.
122
+
123
+ ## Usage
124
+
125
+ ```python
126
+ import shachen
127
+
128
+ result = shachen.run_debra(scene, emissivity=camel, skin_temperature=merra_ts)
129
+ result["cf_comb"] # combined dust confidence, 0–1
130
+ ```
131
+
132
+ What `scene` must contain, the two background schemes, and the imagery chain
133
+ are covered in the [user guide](https://ringsaturn.github.io/shachen/guide.html).
134
+
135
+ Reproducing a reference case end to end needs `[all]` plus an
136
+ [Earthdata](https://urs.earthdata.nasa.gov/) login in `~/.netrc` (MERRA-2 and
137
+ CAMEL are authenticated downloads; GOES L1b on AWS S3 is anonymous):
138
+
139
+ ```sh
140
+ python scripts/fetch_case.py 2017-03-23-swus # the paper's Figure 6 case
141
+ python scripts/run_case.py 2017-03-23-swus # → netCDF + PNG
142
+ ```
143
+
144
+ ## Deviations from the paper
145
+
146
+ Three printed equations are inconsistent with the paper's own prose and figures
147
+ even after the erratum, and are implemented per the prose:
148
+
149
+ | Equation | Deviation |
150
+ |---|---|
151
+ | Eq. 4 (CM2) | Magnitude reversed — as printed it saturates the cloud mask over clear sky |
152
+ | Eq. 11 (CM_day) | Uses CM3, not the misprinted CM4 (the 3.9 µm test is night-only) |
153
+ | Eq. 15 (DT3) | Magnitude reversed — the printed form contradicts the stated intent |
154
+
155
+ Plus one substitution (CAMEL emissivity for the registration-walled UWBF) and
156
+ one opt-in per-sensor retune.
157
+
158
+ **All of it, with the reasoning and the numbers, is in
159
+ [`docs/deviations.md`](docs/deviations.md).** Read that before changing any of
160
+ it. `constants.py` is the single source of every calibration bound, offset and
161
+ weight from the paper, unit-tested against an independent transcription.
162
+
163
+ ## Citation
164
+
165
+ If you use this software, please cite the original algorithm:
166
+
167
+ > Miller, S. D., Bankert, R. L., Grasso, L. D., Lindsey, D. T., Kuciauskas,
168
+ > A. P., & Combs, C. L. (2017). A dynamic enhancement with background reduction
169
+ > algorithm: Overview and application to satellite-based dust storm detection.
170
+ > *Journal of Geophysical Research: Atmospheres*, 122, 12,938–12,959.
171
+ > https://doi.org/10.1002/2017JD027365
172
+
173
+ and, for the implementation, the metadata in `CITATION.cff`.
174
+
175
+ This is an independent implementation. It is not produced, endorsed, or
176
+ verified by the paper's authors, by CIRA, or by NOAA.
177
+
178
+ ## License
179
+
180
+ [Apache-2.0](LICENSE). See `NOTICE` for attribution requirements.
@@ -0,0 +1,137 @@
1
+ # shachen (沙尘)
2
+
3
+ Infrared satellite **dust storm detection** in Python — an open implementation
4
+ of **DEBRA-Dust**, the Dynamic Enhancement with Background Reduction Algorithm
5
+ (Miller et al. 2017, [doi:10.1002/2017JD027365](https://doi.org/10.1002/2017JD027365)),
6
+ for GOES ABI and Himawari AHI.
7
+
8
+ *shachen* (沙尘) is Chinese for "sand and dust". The package is a home for
9
+ infrared-channel dust algorithms; DEBRA-Dust is the first one.
10
+
11
+ This appears to be the first public implementation of DEBRA.
12
+
13
+ > **All equations follow the erratum published 26 February 2020**, not the
14
+ > figures as originally printed.
15
+
16
+ ![DEBRA-Dust enhanced imagery from GOES-16 ABI and Himawari-8 AHI](docs/img/dust-cases.png)
17
+
18
+ Dust is the yellow modulation; everything else stays in greyscale infrared.
19
+ Left is the case from the paper's Figure 6. Both panels come straight out of
20
+ `scripts/run_case.py`, one per sensor.
21
+
22
+ ## What it does
23
+
24
+ DEBRA turns the split-window infrared signal that is specific to *mineral*
25
+ dust into a per-pixel confidence field, by comparing each pixel against a
26
+ dynamically estimated **clear-sky background** rather than a fixed threshold.
27
+ That background is what lets it work over bright, emissivity-heterogeneous
28
+ desert surfaces where fixed thresholds produce false alarms.
29
+
30
+ ```
31
+ io.satellite.load_scene L1b → bt_* / refl_* on the 2 km fixed grid (satpy)
32
+
33
+
34
+ pipeline.run_debra
35
+ ├─ geo.regrid_latlon MERRA-2 / CAMEL → satellite grid
36
+ ├─ solar per-pixel solar zenith (day / twilight / night mix)
37
+ ├─ background scheme A: CAMEL emissivity × Planck(MERRA-2 skin T)
38
+ │ or composite scheme B: 14-day cloud-cleared same-hour composite
39
+ ├─ cloudmask Eqs. 1–12, including the dust restoral term
40
+ ├─ dust_tests DT1–DT3, Eqs. 13–15, normalised per-pixel
41
+ ├─ confidence Eqs. 16–22 → cf_comb
42
+ ├─ imagery Eqs. 23–29, CF-modulated RGB
43
+ └─ render georeferenced PNG with coastlines (cartopy)
44
+ ```
45
+
46
+ Only one background scheme is used at a time: `run_debra` requires exactly one
47
+ of `emissivity=` or `background=`. The composite scheme carries the
48
+ split-window water-vapour depression that the semi-analytic one lacks.
49
+
50
+ ## Documentation
51
+
52
+ **<https://ringsaturn.github.io/shachen/>** — user guide, all 29 equations as
53
+ implemented, full API reference, and the deviations page.
54
+
55
+ ```sh
56
+ make -C docs html # → docs/_build/html/index.html
57
+ make -C docs latexpdf # → docs/_build/latex/shachen.pdf (needs a TeX install)
58
+ ```
59
+
60
+ ## Install
61
+
62
+ The core install is small — it runs the entire algorithm on fields you already
63
+ have in memory, and pulls in no I/O or plotting stack:
64
+
65
+ ```sh
66
+ pip install shachen
67
+ ```
68
+
69
+ Add what you need on top:
70
+
71
+ ```sh
72
+ pip install "shachen[satellite]" # satpy: read and calibrate ABI/AHI L1b
73
+ pip install "shachen[data]" # earthaccess/s3fs: fetch MERRA-2, CAMEL, L1b
74
+ pip install "shachen[render]" # cartopy/matplotlib: georeferenced PNG
75
+ pip install "shachen[all]" # everything, for the reproduction scripts
76
+ ```
77
+
78
+ `import shachen` pulls in none of the extras.
79
+
80
+ ## Usage
81
+
82
+ ```python
83
+ import shachen
84
+
85
+ result = shachen.run_debra(scene, emissivity=camel, skin_temperature=merra_ts)
86
+ result["cf_comb"] # combined dust confidence, 0–1
87
+ ```
88
+
89
+ What `scene` must contain, the two background schemes, and the imagery chain
90
+ are covered in the [user guide](https://ringsaturn.github.io/shachen/guide.html).
91
+
92
+ Reproducing a reference case end to end needs `[all]` plus an
93
+ [Earthdata](https://urs.earthdata.nasa.gov/) login in `~/.netrc` (MERRA-2 and
94
+ CAMEL are authenticated downloads; GOES L1b on AWS S3 is anonymous):
95
+
96
+ ```sh
97
+ python scripts/fetch_case.py 2017-03-23-swus # the paper's Figure 6 case
98
+ python scripts/run_case.py 2017-03-23-swus # → netCDF + PNG
99
+ ```
100
+
101
+ ## Deviations from the paper
102
+
103
+ Three printed equations are inconsistent with the paper's own prose and figures
104
+ even after the erratum, and are implemented per the prose:
105
+
106
+ | Equation | Deviation |
107
+ |---|---|
108
+ | Eq. 4 (CM2) | Magnitude reversed — as printed it saturates the cloud mask over clear sky |
109
+ | Eq. 11 (CM_day) | Uses CM3, not the misprinted CM4 (the 3.9 µm test is night-only) |
110
+ | Eq. 15 (DT3) | Magnitude reversed — the printed form contradicts the stated intent |
111
+
112
+ Plus one substitution (CAMEL emissivity for the registration-walled UWBF) and
113
+ one opt-in per-sensor retune.
114
+
115
+ **All of it, with the reasoning and the numbers, is in
116
+ [`docs/deviations.md`](docs/deviations.md).** Read that before changing any of
117
+ it. `constants.py` is the single source of every calibration bound, offset and
118
+ weight from the paper, unit-tested against an independent transcription.
119
+
120
+ ## Citation
121
+
122
+ If you use this software, please cite the original algorithm:
123
+
124
+ > Miller, S. D., Bankert, R. L., Grasso, L. D., Lindsey, D. T., Kuciauskas,
125
+ > A. P., & Combs, C. L. (2017). A dynamic enhancement with background reduction
126
+ > algorithm: Overview and application to satellite-based dust storm detection.
127
+ > *Journal of Geophysical Research: Atmospheres*, 122, 12,938–12,959.
128
+ > https://doi.org/10.1002/2017JD027365
129
+
130
+ and, for the implementation, the metadata in `CITATION.cff`.
131
+
132
+ This is an independent implementation. It is not produced, endorsed, or
133
+ verified by the paper's authors, by CIRA, or by NOAA.
134
+
135
+ ## License
136
+
137
+ [Apache-2.0](LICENSE). See `NOTICE` for attribution requirements.
@@ -0,0 +1,102 @@
1
+ [project]
2
+ name = "shachen"
3
+ version = "0.1.0"
4
+ description = "Infrared satellite dust storm detection — an open implementation of the DEBRA-Dust algorithm for GOES ABI and Himawari AHI"
5
+ readme = "README.md"
6
+ license = "Apache-2.0"
7
+ license-files = [
8
+ "LICENSE",
9
+ "NOTICE",
10
+ ]
11
+ requires-python = ">=3.12"
12
+ keywords = [
13
+ "dust",
14
+ "dust-storm",
15
+ "sand-dust",
16
+ "DEBRA",
17
+ "satellite",
18
+ "remote-sensing",
19
+ "infrared",
20
+ "split-window",
21
+ "aerosol",
22
+ "GOES",
23
+ "ABI",
24
+ "Himawari",
25
+ "AHI",
26
+ "atmospheric-science",
27
+ ]
28
+ classifiers = [
29
+ "Development Status :: 3 - Alpha",
30
+ "Intended Audience :: Science/Research",
31
+ "Operating System :: OS Independent",
32
+ "Programming Language :: Python :: 3.12",
33
+ "Programming Language :: Python :: 3.13",
34
+ "Topic :: Scientific/Engineering :: Atmospheric Science",
35
+ "Topic :: Scientific/Engineering :: Image Processing",
36
+ ]
37
+ dependencies = [
38
+ "global-land-mask>=1.0.0",
39
+ "numpy>=2.5.2",
40
+ "pyorbital>=1.12.1",
41
+ "pyresample>=1.35.0",
42
+ "scipy>=1.18.1",
43
+ "xarray>=2026.7.0",
44
+ ]
45
+
46
+ [[project.authors]]
47
+ name = "Han Xiao"
48
+ email = "ringsaturn.me@gmail.com"
49
+
50
+ [project.urls]
51
+ Homepage = "https://github.com/ringsaturn/shachen"
52
+ Repository = "https://github.com/ringsaturn/shachen"
53
+ Issues = "https://github.com/ringsaturn/shachen/issues"
54
+ Paper = "https://doi.org/10.1002/2017JD027365"
55
+
56
+ [project.optional-dependencies]
57
+ satellite = [
58
+ "satpy>=0.45",
59
+ "dask>=2026.7.1",
60
+ "netcdf4>=1.7.4",
61
+ ]
62
+ data = [
63
+ "earthaccess>=0.18.0",
64
+ "netcdf4>=1.7.4",
65
+ "s3fs>=2026.7.0",
66
+ ]
67
+ render = [
68
+ "cartopy>=0.25.0",
69
+ "matplotlib>=3.11.1",
70
+ ]
71
+ all = ["shachen[satellite,data,render]"]
72
+
73
+ [tool.ruff]
74
+ line-length = 100
75
+
76
+ [tool.ruff.lint]
77
+ select = [
78
+ "E4",
79
+ "E7",
80
+ "E9",
81
+ "F",
82
+ "I",
83
+ "UP",
84
+ "B",
85
+ ]
86
+
87
+ [build-system]
88
+ requires = ["uv_build>=0.11.31,<0.12.0"]
89
+ build-backend = "uv_build"
90
+
91
+ [dependency-groups]
92
+ dev = [
93
+ "pytest>=9.1.1",
94
+ "ruff>=0.16.4",
95
+ "shachen[all]",
96
+ ]
97
+ docs = [
98
+ "furo>=2024.8.6",
99
+ "myst-parser>=4.0.0",
100
+ "sphinx>=8.1.3",
101
+ "sphinx-copybutton>=0.5.2",
102
+ ]