cmaq-tools 0.1.0__tar.gz

cmaq_tools-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

cmaq_tools-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

cmaq_tools-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 CAMQ Tools Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cmaq_tools-0.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: cmaq-tools
+Version: 0.1.0
+Summary: A Python library for extracting and processing air quality model data from AELMO NetCDF files
+Project-URL: Homepage, https://github.com/zusiven/cmaq_tools
+Project-URL: Repository, https://github.com/zusiven/cmaq_tools.git
+Project-URL: Documentation, https://github.com/zusiven/cmaq_tools
+Author: CMAQ Tools Team
+License-File: LICENSE
+Keywords: aelmo,air-quality,atmospheric-modeling,data-extraction,netcdf
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Requires-Python: >=3.11
+Requires-Dist: netcdf4
+Requires-Dist: polars>=1.37.1
+Requires-Dist: pyproj
+Requires-Dist: wztools>=2026.1.6
+Requires-Dist: xarray>=2025.4.0
+Provides-Extra: dev
+Requires-Dist: jupyter>=1.0.0; extra == 'dev'
+Requires-Dist: matplotlib>=3.5.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: twine>=6.2.0; extra == 'dev'
+Provides-Extra: examples
+Requires-Dist: jupyter>=1.0.0; extra == 'examples'
+Requires-Dist: matplotlib>=3.5.0; extra == 'examples'
+Description-Content-Type: text/markdown
+
+# CMAQ Tools
+
+一个用于从 AELMO NetCDF 文件中提取和处理空气质量模型数据的 Python 库。
+
+## 安装
+
+```bash
+pip install git+https://github.com/zusiven/cmaq_tools.git
+```
+
+## 使用方法
+
+```python
+from cmaq_tools import AelmoExtractor
+from pathlib import Path
+
+# 初始化提取器
+extractor = AelmoExtractor(
+    aelmo_path=Path("path/to/CCTM_AELMO_d01.nc"),
+    cro2d_path=Path("path/to/GRIDCRO2D_d01.nc")
+)
+
+# 提取所有数据
+df = extractor.extract_data()
+print(df)
+
+# 根据经纬度提取特定位置的数据
+df_point = extractor.extract_data_by_lonlat(lon=114.0, lat=38.0)
+print(df_point)
+```
+
+## 支持的污染物
+
+- O3 (臭氧)
+- PM2.5 (细颗粒物)
+- PM10 (可吸入颗粒物)
+- NO2 (二氧化氮)
+- CO (一氧化碳)
+- NO (一氧化氮)
+- SO2 (二氧化硫)
+
+## 依赖
+
+- polars
+- xarray
+- netcdf4
+- pyproj
+- wztools

cmaq_tools-0.1.0/README.md

@@ -0,0 +1,48 @@
+# CMAQ Tools
+
+一个用于从 AELMO NetCDF 文件中提取和处理空气质量模型数据的 Python 库。
+
+## 安装
+
+```bash
+pip install git+https://github.com/zusiven/cmaq_tools.git
+```
+
+## 使用方法
+
+```python
+from cmaq_tools import AelmoExtractor
+from pathlib import Path
+
+# 初始化提取器
+extractor = AelmoExtractor(
+    aelmo_path=Path("path/to/CCTM_AELMO_d01.nc"),
+    cro2d_path=Path("path/to/GRIDCRO2D_d01.nc")
+)
+
+# 提取所有数据
+df = extractor.extract_data()
+print(df)
+
+# 根据经纬度提取特定位置的数据
+df_point = extractor.extract_data_by_lonlat(lon=114.0, lat=38.0)
+print(df_point)
+```
+
+## 支持的污染物
+
+- O3 (臭氧)
+- PM2.5 (细颗粒物)
+- PM10 (可吸入颗粒物)
+- NO2 (二氧化氮)
+- CO (一氧化碳)
+- NO (一氧化氮)
+- SO2 (二氧化硫)
+
+## 依赖
+
+- polars
+- xarray
+- netcdf4
+- pyproj
+- wztools

cmaq_tools-0.1.0/cmaq_tools/__init__.py

@@ -0,0 +1,3 @@
+from .aelmo_extractor import AelmoExtractor
+
+__all__ = ["AelmoExtractor"]

cmaq_tools-0.1.0/cmaq_tools/aelmo_extractor.py

@@ -0,0 +1,130 @@
+
+import polars as pl 
+import xarray as xr
+import datetime as dt
+import numpy as np
+
+from pyproj import Proj
+from pathlib import Path
+from wztools import fetch_nearest_point
+
+
+class AelmoExtractor:
+    def __init__(self, aelmo_path: Path|str, cro2d_path: Path|str) -> None:
+        """
+        >>> aermo_extractor = AelmoExtractor(aelmo_path, cro2d_path)
+        >>> # 提取某点数据
+        >>> df = aermo_extractor.extract_data_by_lonlat(lon, lat)
+        >>>
+        >>> # 提起网格数据
+        >>> df_grid = aermo_extractor.extract_data()
+        """
+        self.aelmo_path = Path(aelmo_path)
+        self.cro2d_path = Path(cro2d_path)
+
+    def extract_data(self) -> pl.DataFrame:
+        ds = xr.open_dataset(self.aelmo_path, engine="netcdf4")
+
+        # 加载地理信息文件
+        ds_grid = xr.open_dataset(self.cro2d_path)
+        # 获取经纬度 (通常是二维数组)
+        lons = ds_grid['LON'].squeeze().values
+        lats = ds_grid['LAT'].squeeze().values
+
+        # 2. 从属性获取时间元数据
+        sdate = int(ds.attrs['SDATE'])  # YYYYDDD
+        stime = int(ds.attrs['STIME'])  # HHMMSS
+        tstep = int(ds.attrs['TSTEP'])  # HHMMSS
+
+        # 3. 解析起始时间
+        start_dt = dt.datetime.strptime(str(sdate), '%Y%j')
+        # 补全 6 位时间格式 (例如 51802 -> 051802)
+        s_str = str(stime).zfill(6)
+        start_dt += dt.timedelta(hours=int(s_str[:2]), minutes=int(s_str[2:4]), seconds=int(s_str[4:6]))
+
+        # 4. 解析步长 (TSTEP)
+        ts_str = str(tstep).zfill(6)
+        tstep_delta = dt.timedelta(hours=int(ts_str[:2]), minutes=int(ts_str[2:4]), seconds=int(ts_str[4:6]))
+
+        # 5. 生成时间序列（修复 FutureWarning）
+        # 使用 ds.sizes 代替 ds.dims
+        num_steps = ds.sizes['TSTEP'] 
+        time_values = [start_dt + i * tstep_delta for i in range(num_steps)]
+        time_values = [t + dt.timedelta(hours=8) for t in time_values]
+
+        # 6. 重新定义坐标
+        ds = ds.assign_coords(time=('TSTEP', time_values)).swap_dims({'TSTEP': 'time'})
+
+        O3_data = ds.variables["O3"][:] * 1963
+        NO2_data = ds.variables["NO2"][:] * 1881
+        NO_data = ds.variables["NO"][:] * 1227
+        PM10_data = ds.variables["PM10"][:]
+        PM25_data = ds.variables["PM25"][:]
+        CO_data = ds.variables["CO"][:] * 1.144
+        SO2_data = ds.variables["SO2"][:] * 2619.6
+
+        # lons = lons.values
+        # lats = lats.values
+
+        dfs = []
+        nx = ds.sizes['COL']
+        ny = ds.sizes['ROW']
+
+        for index, t in enumerate(time_values):
+            _O3_data = O3_data[index][0].values
+            _PM10_data = PM10_data[index][0].values
+            _PM25_data = PM25_data[index][0].values
+            _NO_data = NO_data[index][0].values
+            _NO2_data = NO2_data[index][0].values
+            _CO_data = CO_data[index][0].values
+            _SO2_data = SO2_data[index][0].values
+
+            df_t = pl.DataFrame({
+                "time": [t] * nx * ny,
+                "lon": lons.flatten(), 
+                "lat": lats.flatten(), 
+                "O3": _O3_data.flatten(), 
+                "PM10": _PM10_data.flatten(), 
+                "PM25": _PM25_data.flatten(), 
+                "NO2": _NO2_data.flatten(), 
+                "CO": _CO_data.flatten(), 
+                "NO": _NO_data.flatten(), 
+                "SO2": _SO2_data.flatten(), 
+            })
+            dfs.append(df_t)      
+        # print(O3_data.shape)
+        # print(len(time_values))
+        df = pl.concat(dfs)
+        df = df.with_columns(
+            *[pl.col(col).cast(pl.Float64).round(4) for col in df.columns if col not in ["time"]]
+        )
+
+        return df
+
+    def extract_data_by_lonlat(self, lon, lat) -> pl.DataFrame:
+        df = self.extract_data()
+
+        nerest_lon, nearest_lat = fetch_nearest_point(df, tar_lon=lon, tar_lat=lat)
+        df = df.filter(
+            (pl.col("lon") == nerest_lon)
+            &
+            (pl.col("lat") == nearest_lat)
+        ).sort("time")
+
+        df = df.rename({"time": "datetime"})
+        return df
+
+
+
+if __name__ == "__main__":
+    file_path = Path(r"C:\Users\Administrator\Desktop\tmp\CCTM_AELMO_d01_yixing2.nc")
+    cro2d_path = Path(r"C:\Users\Administrator\Desktop\tmp\GRIDCRO2D_d01_yixing2.nc")
+
+    lon = 114
+    lat = 38
+
+    aermo_extractor = AelmoExtractor(file_path, cro2d_path)
+
+    aermo_extractor.extract_data()
+    df = aermo_extractor.extract_data_by_lonlat(lon, lat)
+    print(df)

cmaq_tools-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[project]
+name = "cmaq-tools"
+version = "0.1.0"
+description = "A Python library for extracting and processing air quality model data from AELMO NetCDF files"
+readme = "README.md"
+requires-python = ">=3.11"
+authors = [
+    {name = "CMAQ Tools Team"}
+]
+keywords = ["air-quality", "atmospheric-modeling", "netcdf", "data-extraction", "aelmo"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Scientific/Engineering :: Atmospheric Science",
+]
+dependencies = [
+    "netcdf4",
+    "polars>=1.37.1",
+    "pyproj",
+    "wztools>=2026.1.6",
+    "xarray>=2025.4.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "matplotlib>=3.5.0",
+    "jupyter>=1.0.0",
+    "twine>=6.2.0"
+]
+examples = [
+    "matplotlib>=3.5.0",
+    "jupyter>=1.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/zusiven/cmaq_tools"
+Repository = "https://github.com/zusiven/cmaq_tools.git"
+Documentation = "https://github.com/zusiven/cmaq_tools"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["cmaq_tools"]