climaclass 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.
@@ -0,0 +1,24 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ jobs:
9
+ test:
10
+ runs-on: ubuntu-latest
11
+ strategy:
12
+ matrix:
13
+ python-version: ["3.9", "3.11", "3.13"]
14
+ steps:
15
+ - uses: actions/checkout@v4
16
+ - uses: actions/setup-python@v5
17
+ with:
18
+ python-version: ${{ matrix.python-version }}
19
+ - name: Install
20
+ run: python -m pip install -e ".[dev]"
21
+ - name: Lint
22
+ run: ruff check src/
23
+ - name: Test
24
+ run: pytest -q
@@ -0,0 +1,42 @@
1
+ name: Publish to PyPI
2
+
3
+ # Publishes on a GitHub Release (or a v* tag) using PyPI Trusted Publishing
4
+ # (OIDC) — no API token stored in the repo. One-time setup: add a "pending
5
+ # publisher" for project `climaclass` on https://pypi.org/manage/account/publishing/
6
+ # Owner: DarriEy Repo: climaclass Workflow: publish.yml Environment: pypi
7
+
8
+ on:
9
+ release:
10
+ types: [published]
11
+ push:
12
+ tags: ["v*"]
13
+
14
+ jobs:
15
+ build:
16
+ runs-on: ubuntu-latest
17
+ steps:
18
+ - uses: actions/checkout@v4
19
+ - uses: actions/setup-python@v5
20
+ with:
21
+ python-version: "3.11"
22
+ - name: Build sdist and wheel
23
+ run: |
24
+ python -m pip install build
25
+ python -m build
26
+ - uses: actions/upload-artifact@v4
27
+ with:
28
+ name: dist
29
+ path: dist/
30
+
31
+ publish:
32
+ needs: build
33
+ runs-on: ubuntu-latest
34
+ environment: pypi
35
+ permissions:
36
+ id-token: write # required for Trusted Publishing
37
+ steps:
38
+ - uses: actions/download-artifact@v4
39
+ with:
40
+ name: dist
41
+ path: dist/
42
+ - uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,10 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ *.egg-info/
4
+ .pytest_cache/
5
+ .ruff_cache/
6
+ build/
7
+ dist/
8
+ .DS_Store
9
+ .venv/
10
+ venv/
@@ -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 Derivative
95
+ 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 2024-2026 Darri Eythorsson
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.
@@ -0,0 +1,17 @@
1
+ climaclass
2
+ Copyright 2024-2026 Darri Eythorsson
3
+
4
+ This product includes software developed by Darri Eythorsson.
5
+
6
+ The classification algorithms reimplement the methods previously prototyped in
7
+ the author's Climate_Classifications project (Google Earth Engine notebooks),
8
+ relicensed by the copyright holder under the Apache License, Version 2.0.
9
+
10
+ Scientific references:
11
+ - Peel, M. C., Finlayson, B. L., & McMahon, T. A. (2007). Updated world map
12
+ of the Koppen-Geiger climate classification. HESS, 11, 1633-1644.
13
+ - Beck, H. E., et al. (2018). Present and future Koppen-Geiger climate
14
+ classification maps at 1-km resolution. Scientific Data, 5, 180214.
15
+ - Holdridge, L. R. (1967). Life Zone Ecology. Tropical Science Center.
16
+ - Thornthwaite, C. W. (1948). An approach toward a rational classification of
17
+ climate. Geographical Review, 38(1), 55-94.
@@ -0,0 +1,111 @@
1
+ Metadata-Version: 2.4
2
+ Name: climaclass
3
+ Version: 0.1.0
4
+ Summary: Classical climate classification (Koppen-Geiger, Holdridge, Thornthwaite) from monthly climatologies - pure Python, no Earth Engine required.
5
+ Project-URL: Homepage, https://github.com/DarriEy/Climate_Classifications
6
+ Project-URL: Source, https://github.com/DarriEy/Climate_Classifications
7
+ Author: Darri Eythorsson
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE
10
+ License-File: NOTICE
11
+ Keywords: classification,climate,climatology,holdridge,hydrology,koppen,thornthwaite
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
16
+ Requires-Python: >=3.9
17
+ Provides-Extra: dev
18
+ Requires-Dist: numpy; extra == 'dev'
19
+ Requires-Dist: pytest>=7; extra == 'dev'
20
+ Requires-Dist: ruff>=0.1; extra == 'dev'
21
+ Provides-Extra: symfluence
22
+ Requires-Dist: geopandas>=0.12; extra == 'symfluence'
23
+ Requires-Dist: rasterstats>=0.18; extra == 'symfluence'
24
+ Description-Content-Type: text/markdown
25
+
26
+ # climaclass
27
+
28
+ **Classical climate classification from monthly climatologies — pure Python, no Earth Engine required.**
29
+
30
+ `climaclass` turns a 12-month climatology of temperature and precipitation into a
31
+ climate class under three classical schemes:
32
+
33
+ | Scheme | Reference | Output |
34
+ |--------|-----------|--------|
35
+ | **Köppen–Geiger** | Peel et al. (2007); legend of Beck et al. (2018) | code (`Csb`) + zone 1–30 |
36
+ | **Holdridge life zones** | Holdridge (1967) | life-zone name + belt/province |
37
+ | **Thornthwaite** | Thornthwaite (1948) | moisture + thermal province |
38
+
39
+ It grew out of the [`Climate_Classifications`](https://github.com/DarriEy/Climate_Classifications)
40
+ Earth-Engine notebooks, but reimplements the *algorithms* as dependency-free
41
+ Python so they run anywhere — a laptop, a CI job, or inside a hydrological model
42
+ pipeline — without a Google Earth Engine account.
43
+
44
+ ## Install
45
+
46
+ ```bash
47
+ pip install climaclass # core: zero dependencies
48
+ pip install "climaclass[symfluence]" # + SYMFLUENCE attribute-processor plugin
49
+ ```
50
+
51
+ ## Use
52
+
53
+ ```python
54
+ from climaclass import MonthlyClimate, classify
55
+
56
+ reykjavik = MonthlyClimate(
57
+ temp=[0.1, 0.4, 0.9, 3.3, 6.8, 9.4, 10.9, 10.5, 7.7, 4.5, 1.7, 0.4], # °C, Jan..Dec
58
+ precip=[76, 72, 82, 58, 44, 50, 52, 62, 67, 86, 73, 79], # mm, Jan..Dec
59
+ latitude=64.1,
60
+ )
61
+
62
+ results = classify(reykjavik)
63
+ print(results["koppen"].code) # 'Cfc' (subpolar oceanic)
64
+ print(results["holdridge"].name) # e.g. 'Boreal moist forest'
65
+ print(results["thornthwaite"].code) # moisture/thermal province code
66
+ print(results["koppen"].details) # MAT, MAP, Pthreshold, ... for QA
67
+ ```
68
+
69
+ Run a single scheme directly:
70
+
71
+ ```python
72
+ from climaclass import koppen
73
+ koppen.classify(reykjavik).zone # 16 (Beck et al. legend)
74
+ ```
75
+
76
+ ### Input
77
+
78
+ Everything keys off one small record, `MonthlyClimate`:
79
+
80
+ - `temp` — 12 monthly **mean** temperatures (°C), January → December *(required)*
81
+ - `precip` — 12 monthly **total** precipitation (mm), January → December *(required)*
82
+ - `latitude` — optional; refines Thornthwaite PET day-length and fixes hemisphere
83
+ - `tmin` / `tmax` — optional, reserved for future scheme variants
84
+
85
+ ## SYMFLUENCE plugin
86
+
87
+ The optional `symfluence` extra ships an attribute processor that emits climate
88
+ classes as catchment attributes (`climate.koppen_code`, `climate.holdridge_zone`,
89
+ `climate.thornthwaite_code`, …), computed from the **WorldClim** monthly rasters
90
+ SYMFLUENCE already acquires — so there is no new data dependency and no Earth
91
+ Engine in the loop. It is registered via the `symfluence.attribute_processors`
92
+ entry point and can be used as a regionalization / PUB grouping variable.
93
+
94
+ The integration is fully decoupled: importing `climaclass` never imports
95
+ SYMFLUENCE, and the pure mapping helper `record_to_attributes(temp, precip)` is
96
+ testable on its own.
97
+
98
+ ## Develop
99
+
100
+ ```bash
101
+ pip install -e ".[dev]"
102
+ pytest -q
103
+ ruff check src/
104
+ ```
105
+
106
+ ## License
107
+
108
+ Apache License 2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE). The
109
+ classification algorithms were prototyped in the author's
110
+ `Climate_Classifications` Earth-Engine notebooks and relicensed by the
111
+ copyright holder.
@@ -0,0 +1,86 @@
1
+ # climaclass
2
+
3
+ **Classical climate classification from monthly climatologies — pure Python, no Earth Engine required.**
4
+
5
+ `climaclass` turns a 12-month climatology of temperature and precipitation into a
6
+ climate class under three classical schemes:
7
+
8
+ | Scheme | Reference | Output |
9
+ |--------|-----------|--------|
10
+ | **Köppen–Geiger** | Peel et al. (2007); legend of Beck et al. (2018) | code (`Csb`) + zone 1–30 |
11
+ | **Holdridge life zones** | Holdridge (1967) | life-zone name + belt/province |
12
+ | **Thornthwaite** | Thornthwaite (1948) | moisture + thermal province |
13
+
14
+ It grew out of the [`Climate_Classifications`](https://github.com/DarriEy/Climate_Classifications)
15
+ Earth-Engine notebooks, but reimplements the *algorithms* as dependency-free
16
+ Python so they run anywhere — a laptop, a CI job, or inside a hydrological model
17
+ pipeline — without a Google Earth Engine account.
18
+
19
+ ## Install
20
+
21
+ ```bash
22
+ pip install climaclass # core: zero dependencies
23
+ pip install "climaclass[symfluence]" # + SYMFLUENCE attribute-processor plugin
24
+ ```
25
+
26
+ ## Use
27
+
28
+ ```python
29
+ from climaclass import MonthlyClimate, classify
30
+
31
+ reykjavik = MonthlyClimate(
32
+ temp=[0.1, 0.4, 0.9, 3.3, 6.8, 9.4, 10.9, 10.5, 7.7, 4.5, 1.7, 0.4], # °C, Jan..Dec
33
+ precip=[76, 72, 82, 58, 44, 50, 52, 62, 67, 86, 73, 79], # mm, Jan..Dec
34
+ latitude=64.1,
35
+ )
36
+
37
+ results = classify(reykjavik)
38
+ print(results["koppen"].code) # 'Cfc' (subpolar oceanic)
39
+ print(results["holdridge"].name) # e.g. 'Boreal moist forest'
40
+ print(results["thornthwaite"].code) # moisture/thermal province code
41
+ print(results["koppen"].details) # MAT, MAP, Pthreshold, ... for QA
42
+ ```
43
+
44
+ Run a single scheme directly:
45
+
46
+ ```python
47
+ from climaclass import koppen
48
+ koppen.classify(reykjavik).zone # 16 (Beck et al. legend)
49
+ ```
50
+
51
+ ### Input
52
+
53
+ Everything keys off one small record, `MonthlyClimate`:
54
+
55
+ - `temp` — 12 monthly **mean** temperatures (°C), January → December *(required)*
56
+ - `precip` — 12 monthly **total** precipitation (mm), January → December *(required)*
57
+ - `latitude` — optional; refines Thornthwaite PET day-length and fixes hemisphere
58
+ - `tmin` / `tmax` — optional, reserved for future scheme variants
59
+
60
+ ## SYMFLUENCE plugin
61
+
62
+ The optional `symfluence` extra ships an attribute processor that emits climate
63
+ classes as catchment attributes (`climate.koppen_code`, `climate.holdridge_zone`,
64
+ `climate.thornthwaite_code`, …), computed from the **WorldClim** monthly rasters
65
+ SYMFLUENCE already acquires — so there is no new data dependency and no Earth
66
+ Engine in the loop. It is registered via the `symfluence.attribute_processors`
67
+ entry point and can be used as a regionalization / PUB grouping variable.
68
+
69
+ The integration is fully decoupled: importing `climaclass` never imports
70
+ SYMFLUENCE, and the pure mapping helper `record_to_attributes(temp, precip)` is
71
+ testable on its own.
72
+
73
+ ## Develop
74
+
75
+ ```bash
76
+ pip install -e ".[dev]"
77
+ pytest -q
78
+ ruff check src/
79
+ ```
80
+
81
+ ## License
82
+
83
+ Apache License 2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE). The
84
+ classification algorithms were prototyped in the author's
85
+ `Climate_Classifications` Earth-Engine notebooks and relicensed by the
86
+ copyright holder.
@@ -0,0 +1,44 @@
1
+ [build-system]
2
+ requires = ["hatchling"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "climaclass"
7
+ version = "0.1.0"
8
+ description = "Classical climate classification (Koppen-Geiger, Holdridge, Thornthwaite) from monthly climatologies - pure Python, no Earth Engine required."
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ license = "Apache-2.0"
12
+ license-files = ["LICENSE", "NOTICE"]
13
+ authors = [{ name = "Darri Eythorsson" }]
14
+ keywords = ["climate", "koppen", "holdridge", "thornthwaite", "classification", "hydrology", "climatology"]
15
+ classifiers = [
16
+ "Development Status :: 4 - Beta",
17
+ "Intended Audience :: Science/Research",
18
+ "Programming Language :: Python :: 3",
19
+ "Topic :: Scientific/Engineering :: Atmospheric Science",
20
+ ]
21
+ dependencies = [] # core is pure standard-library Python
22
+
23
+ [project.optional-dependencies]
24
+ # Integration with the SYMFLUENCE hydrological-modelling framework.
25
+ symfluence = ["geopandas>=0.12", "rasterstats>=0.18"]
26
+ dev = ["pytest>=7", "ruff>=0.1", "numpy"]
27
+
28
+ [project.urls]
29
+ Homepage = "https://github.com/DarriEy/Climate_Classifications"
30
+ Source = "https://github.com/DarriEy/Climate_Classifications"
31
+
32
+ # Optional: expose the processor to SYMFLUENCE's plugin discovery via entry point.
33
+ [project.entry-points."symfluence.attribute_processors"]
34
+ climate_classification = "climaclass.integrations.symfluence:ClimateClassificationProcessor"
35
+
36
+ [tool.hatch.build.targets.wheel]
37
+ packages = ["src/climaclass"]
38
+
39
+ [tool.ruff]
40
+ line-length = 120
41
+ target-version = "py39"
42
+
43
+ [tool.pytest.ini_options]
44
+ testpaths = ["tests"]
@@ -0,0 +1,66 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ # Copyright (c) 2024-2026 Darri Eythorsson
3
+
4
+ """climaclass - classical climate classification from monthly climatologies.
5
+
6
+ Three classical schemes, one tiny input record, zero heavy dependencies:
7
+
8
+ >>> from climaclass import MonthlyClimate, classify
9
+ >>> rome = MonthlyClimate(
10
+ ... temp=[8, 9, 11, 14, 18, 22, 25, 25, 21, 17, 12, 9],
11
+ ... precip=[80, 75, 70, 65, 50, 35, 20, 30, 70, 110, 110, 95],
12
+ ... )
13
+ >>> classify(rome)["koppen"].code
14
+ 'Csa'
15
+
16
+ Each classifier consumes a :class:`MonthlyClimate` and returns a
17
+ :class:`ClassificationResult`. The library is pure Python; the optional
18
+ SYMFLUENCE integration lives in :mod:`climaclass.integrations.symfluence` and is
19
+ only imported when you ask for it.
20
+ """
21
+
22
+ from __future__ import annotations
23
+
24
+ from typing import Dict
25
+
26
+ from . import holdridge, koppen, thornthwaite
27
+ from ._types import ClassificationResult, MonthlyClimate
28
+
29
+ __version__ = "0.1.0"
30
+
31
+ __all__ = [
32
+ "MonthlyClimate",
33
+ "ClassificationResult",
34
+ "classify",
35
+ "koppen",
36
+ "holdridge",
37
+ "thornthwaite",
38
+ ]
39
+
40
+ _SCHEMES = {
41
+ "koppen": koppen.classify,
42
+ "holdridge": holdridge.classify,
43
+ "thornthwaite": thornthwaite.classify,
44
+ }
45
+
46
+
47
+ def classify(climate: MonthlyClimate, schemes=None) -> Dict[str, ClassificationResult]:
48
+ """Run one or more classification schemes on a climatology.
49
+
50
+ Args:
51
+ climate: The 12-month climatology to classify.
52
+ schemes: Iterable of scheme names to run. Defaults to all three
53
+ (``"koppen"``, ``"holdridge"``, ``"thornthwaite"``).
54
+
55
+ Returns:
56
+ Mapping of scheme name -> :class:`ClassificationResult`.
57
+ """
58
+ if schemes is None:
59
+ schemes = _SCHEMES.keys()
60
+ out: Dict[str, ClassificationResult] = {}
61
+ for name in schemes:
62
+ try:
63
+ out[name] = _SCHEMES[name](climate)
64
+ except KeyError as exc:
65
+ raise ValueError(f"Unknown scheme: {name!r}. Choose from {sorted(_SCHEMES)}") from exc
66
+ return out