climkit 0.0.3__tar.gz

climkit-0.0.3/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Tingyang Song
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

climkit-0.0.3/MANIFEST.in

@@ -0,0 +1 @@
+include requirements.txt

climkit-0.0.3/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: climkit
+Version: 0.0.3
+Summary: Some tool function package for Climate
+Home-page: https://github.com/hhhopsong/climkit
+Author: Tingyang Song
+Author-email: 1057422494@qq.com
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.26
+Requires-Dist: pandas>=2.2
+Requires-Dist: scipy>=1.12
+Requires-Dist: xarray>=2024.1
+Requires-Dist: netCDF4>=1.6
+Requires-Dist: cftime>=1.6
+Requires-Dist: bottleneck>=1.3
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: metpy>=1.6
+Requires-Dist: scikit-learn>=1.4
+Requires-Dist: joblib>=1.3
+Requires-Dist: cartopy>=0.22
+Requires-Dist: shapely>=1.0
+Requires-Dist: pyproj>=3.6
+Requires-Dist: xgrads>=0.2.0
+Requires-Dist: cmaps>=1.5
+Requires-Dist: func_timeout>=1.0
+Requires-Dist: numba>=0.53
+Requires-Dist: salem>=0.2
+Requires-Dist: eofs>=1.0
+Requires-Dist: geopandas>=0.10
+Requires-Dist: pymannkendall>=1.0
+Requires-Dist: statsmodels>=0.9
+Requires-Dist: pycwt
+Requires-Dist: alive_progress
+Requires-Dist: pyproj>=3.6.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+<p align="center">
+  <img src="docs/logo.pdf" alt="ClimKit logo" width="200" />
+</p>
+# 📘 ClimKit — A Climate Data Analysis Toolkit
+
+**ClimKit** 是一个用于气候数据及绘图的 Python 工具集。它包含多种常用数据处理工具，例如波谱分析、温度收支、矢量场可视化等，适用于科研人员、地球科学研究者及数据分析工程师。
+
+---
+
+## 🌟 功能概览
+
+ClimKit 提供以下核心功能模块：
+
+### 🔸 1. **Wavelet Analysis（小波分析和功率谱分析）**
+
+位于 `climkit.wavelet` 和 `climkit.specx_anal`
+
+* 执行连续小波变换（CWT）
+* 分析气候/海洋数据的周期性与多尺度特征
+* 提供功率谱、显著性检验等方法
+
+---
+
+### 🔸 2. **Temperature Budget（温度收支分析）**
+
+位于 `climkit.temperature_budget`
+
+* 计算局地温度场的收支项
+* 用于大气热力诊断
+
+---
+
+### 🔸 3. **K-Means 聚类工具**
+
+位于 `climkit.K_Mean`
+
+* 常用于气候系统聚类分型分析
+
+---
+
+### 🔸 4. **Cquiver — 矢量场绘图**
+
+位于 `climkit.Cquiver`
+
+* 扩展版 matplotlib.quiver
+* 更美观的可视化风场、流场
+
+---
+
+### 🔸 5. **Subfig Adjustment（子图调整）**
+
+位于 `climkit.sub_adjust`
+
+* 绘制地图子图（如：中国黄海；中国南海）
+
+---
+
+### 🔸 6. **Filter （信号滤波）**
+
+位于 `climkit.filter`
+
+* 洛伦兹滤波、滑动滤波、巴特霍夫滤波等
+* 用于对信号进行滤波，并可以绘制响应函数
+
+---
+
+### 🔸 7. **Lonlat transform （经度格式转换）**
+
+位于 `climkit.lonlat_transform`
+
+* 对360度和180度制的经度格式提供互相转换功能
+
+---
+
+### 🔸 8. **Masked （数据裁切）**
+
+位于 `climkit.masked`
+
+* 基于SHP文件对NetCDF数据进行数据裁切
+
+---
+
+### 🔸 9. **LBM forcing data （制作线性斜压模式强迫数据）**
+
+位于 `climkit.force_file`
+
+* 制作NetCDF格式的LBM强迫数据
+* 目前仅支持T42 & 垂直20层配置下的LBM
+
+---
+
+### 🔸 10. **T-N Wave Activity Flux （计算T-N波活动通量）**
+
+位于 `climkit.TN_WaveActivityFlux`
+
+* 基于气候态水平风速场和异常位势高度场计算波活动通量
+* 支持二维和三维波活动通量的计算（三维波活动通量需要提供气候态温度场）
+
+---
+
+## 🚀 安装方式
+
+### **方式一：pip（推荐）**
+
+```bash
+pip install climkit
+```
+
+### **方式二：从源码安装**
+
+```bash
+git clone https://example.com/climkit.git
+cd climkit
+pip install -e .
+```
+
+---
+
+## 🧪 快速开始
+
+---
+
+### 示例：矢量风场绘图
+
+```python
+from climkit.Cquiver import Curlyquiver
+import matplotlib.pyplot as plt
+
+fig = plt.figure()
+ax = fig.add_subplot(projection=*)
+Curlyquiver(ax, x, y, U, V)
+plt.show()
+```
+
+---
+
+## 🛠 其他
+
+项目包含 Pytorch 代码用于GPU加速（可选）。
+
+
+

climkit-0.0.3/README.md

@@ -0,0 +1,142 @@
+<p align="center">
+  <img src="docs/logo.pdf" alt="ClimKit logo" width="200" />
+</p>
+# 📘 ClimKit — A Climate Data Analysis Toolkit
+
+**ClimKit** 是一个用于气候数据及绘图的 Python 工具集。它包含多种常用数据处理工具，例如波谱分析、温度收支、矢量场可视化等，适用于科研人员、地球科学研究者及数据分析工程师。
+
+---
+
+## 🌟 功能概览
+
+ClimKit 提供以下核心功能模块：
+
+### 🔸 1. **Wavelet Analysis（小波分析和功率谱分析）**
+
+位于 `climkit.wavelet` 和 `climkit.specx_anal`
+
+* 执行连续小波变换（CWT）
+* 分析气候/海洋数据的周期性与多尺度特征
+* 提供功率谱、显著性检验等方法
+
+---
+
+### 🔸 2. **Temperature Budget（温度收支分析）**
+
+位于 `climkit.temperature_budget`
+
+* 计算局地温度场的收支项
+* 用于大气热力诊断
+
+---
+
+### 🔸 3. **K-Means 聚类工具**
+
+位于 `climkit.K_Mean`
+
+* 常用于气候系统聚类分型分析
+
+---
+
+### 🔸 4. **Cquiver — 矢量场绘图**
+
+位于 `climkit.Cquiver`
+
+* 扩展版 matplotlib.quiver
+* 更美观的可视化风场、流场
+
+---
+
+### 🔸 5. **Subfig Adjustment（子图调整）**
+
+位于 `climkit.sub_adjust`
+
+* 绘制地图子图（如：中国黄海；中国南海）
+
+---
+
+### 🔸 6. **Filter （信号滤波）**
+
+位于 `climkit.filter`
+
+* 洛伦兹滤波、滑动滤波、巴特霍夫滤波等
+* 用于对信号进行滤波，并可以绘制响应函数
+
+---
+
+### 🔸 7. **Lonlat transform （经度格式转换）**
+
+位于 `climkit.lonlat_transform`
+
+* 对360度和180度制的经度格式提供互相转换功能
+
+---
+
+### 🔸 8. **Masked （数据裁切）**
+
+位于 `climkit.masked`
+
+* 基于SHP文件对NetCDF数据进行数据裁切
+
+---
+
+### 🔸 9. **LBM forcing data （制作线性斜压模式强迫数据）**
+
+位于 `climkit.force_file`
+
+* 制作NetCDF格式的LBM强迫数据
+* 目前仅支持T42 & 垂直20层配置下的LBM
+
+---
+
+### 🔸 10. **T-N Wave Activity Flux （计算T-N波活动通量）**
+
+位于 `climkit.TN_WaveActivityFlux`
+
+* 基于气候态水平风速场和异常位势高度场计算波活动通量
+* 支持二维和三维波活动通量的计算（三维波活动通量需要提供气候态温度场）
+
+---
+
+## 🚀 安装方式
+
+### **方式一：pip（推荐）**
+
+```bash
+pip install climkit
+```
+
+### **方式二：从源码安装**
+
+```bash
+git clone https://example.com/climkit.git
+cd climkit
+pip install -e .
+```
+
+---
+
+## 🧪 快速开始
+
+---
+
+### 示例：矢量风场绘图
+
+```python
+from climkit.Cquiver import Curlyquiver
+import matplotlib.pyplot as plt
+
+fig = plt.figure()
+ax = fig.add_subplot(projection=*)
+Curlyquiver(ax, x, y, U, V)
+plt.show()
+```
+
+---
+
+## 🛠 其他
+
+项目包含 Pytorch 代码用于GPU加速（可选）。
+
+
+