API 参考

按功能查找主要函数与默认参数。输入、输出、科学口径和使用边界见各功能章节。

数据模型

TimeAxis

klimapy.native.TimeAxis

TimeAxis.dates(self)

TimeAxis.calendar(self)

TimeAxis.labels(self)

源码

Field

klimapy.native.Field

Field(values, dims, coords, attrs={}, name="value", coordinate_attrs={})

见 Field 与数据入口。

Field.shape(self)

Field.time(self)

Field.isel(self, **indexers)

Field.to_netcdf(self, path)

源码

read_field

klimapy.native.read_field(path, variable=None, *, indexers=None)

源码

ETCCDI

check_data

klimapy.etccdi.check_data(pr, valid_var_names=None)

源码

check_temperature_data

klimapy.etccdi.check_temperature_data(temp, valid_var_names=None)

源码

select_baseline_period

klimapy.etccdi.select_baseline_period(data, start_year, end_year)

源码

PRCPTOT

klimapy.etccdi.PRCPTOT(pr, *, min_valid_fraction=0.9)

源码

R1mm_days

klimapy.etccdi.R1mm_days(pr, *, min_valid_fraction=0.9)

源码

SDII

klimapy.etccdi.SDII(pr, *, min_valid_fraction=0.9)

源码

RXnday

klimapy.etccdi.RXnday(pr, window=5, *, freq='YS', min_valid_fraction=0.9)

源码

RX1DAY

klimapy.etccdi.RX1DAY(pr, *, freq='YS', min_valid_fraction=0.9)

源码

RX5DAY

klimapy.etccdi.RX5DAY(pr, *, freq='YS', min_valid_fraction=0.9)

源码

CDD

klimapy.etccdi.CDD(pr, *, min_valid_fraction=0.9)

源码

CWD

klimapy.etccdi.CWD(pr, *, min_valid_fraction=0.9)

源码

Rnnmm

klimapy.etccdi.Rnnmm(pr, threshold=10.0, *, min_valid_fraction=0.9)

源码

TN10p

klimapy.etccdi.TN10p(tn, baseline_years=(1961, 1990), *, bootstrap=True, min_valid_fraction=0.9)

源码

TX10p

klimapy.etccdi.TX10p(tx, baseline_years=(1961, 1990), *, bootstrap=True, min_valid_fraction=0.9)

源码

TN90p

klimapy.etccdi.TN90p(tn, baseline_years=(1961, 1990), *, bootstrap=True, min_valid_fraction=0.9)

源码

TX90p

klimapy.etccdi.TX90p(tx, baseline_years=(1961, 1990), *, bootstrap=True, min_valid_fraction=0.9)

源码

WSDI

klimapy.etccdi.WSDI(tx, baseline_years=(1961, 1990), *, min_valid_fraction=0.9)

源码

CSDI

klimapy.etccdi.CSDI(tn, baseline_years=(1961, 1990), *, min_valid_fraction=0.9)

源码

GSL

klimapy.etccdi.GSL(tg, hemisphere='NH', *, min_valid_fraction=0.9)

源码

DTR

klimapy.etccdi.DTR(tx, tn, *, min_valid_fraction=0.9)

源码

compute_indices

klimapy.etccdi.compute_indices(data, indices=None, *, baseline_years=None, min_valid_fraction=0.9, spatial_chunk_size=None, index_options=None)

源码

统计降尺度 / BCSD

bcsd

klimapy.downscaling.bcsd.bcsd(obs_path, gcm_hist_path, gcm_fut_path, model_name, output_dir, ref_start_year, ref_end_year, *, strict=False, bc_options=None, sd_options=None)

源码

BCSD / 偏差校正

bias_correct

klimapy.downscaling.bcsd.bias_correct(obs_path, gcm_hist_path, gcm_fut_path, model_name, ref_start_year, ref_end_year, *, strict=False, time_chunk_size=128, work_dir=None, window_size=None, n_quantiles=None)

源码

close_result

klimapy.downscaling.bcsd.close_result(result, *, remove_work_files=False)

源码

BCSD / 空间分解

downscale

klimapy.downscaling.bcsd.downscale(obs_path, bc_result, output_dir, ref_start_year, ref_end_year, *, strict=False, time_chunk_size=32, spatial_chunk_size=16)

源码

降水变率与趋势

get_precip_var

klimapy.precipitation.variability.get_precip_var(ds)

源码

compute_precip_variability

klimapy.precipitation.variability.compute_precip_variability(ds, baseline_years=None, *, spatial_chunk_size=32, min_valid_fraction=0.9)

源码

compute_precip_variability_split

klimapy.precipitation.variability.compute_precip_variability_split(ds, split_year=2015, *, spatial_chunk_size=32, min_valid_fraction=0.9)

源码

annual_precip_variability_trend

klimapy.precipitation.variability.annual_precip_variability_trend(annual_var, years, baseline_years=None)

源码

calc_annual_precip_variability

klimapy.precipitation.variability.calc_annual_precip_variability(data, years)

源码

remove_annual_cycle

klimapy.precipitation.variability.remove_annual_cycle(precip, years, doy, baseline_years=None)

源码

remove_linear_trend

klimapy.precipitation.variability.remove_linear_trend(data)

源码

calc_precip_variability

klimapy.precipitation.variability.calc_precip_variability(data)

源码

calc_variability_trend

klimapy.precipitation.variability.calc_variability_trend(data, years, doy=None)

源码

统计分析 / 插值

Regridder

klimapy.statistics.interpolation.Regridder

Regridder.close(self)

源码

interpolate

klimapy.statistics.interpolation.interpolate(data, target_grid=None, method='bilinear', *, source_grid=None)

源码

no_interpolation

klimapy.statistics.interpolation.no_interpolation(data)

源码

bilinear

klimapy.statistics.interpolation.bilinear(data, target_grid)

源码

nearest_neighbor

klimapy.statistics.interpolation.nearest_neighbor(data, target_grid)

源码

first_order_conservative

klimapy.statistics.interpolation.first_order_conservative(data, target_grid, *, source_grid=None)

源码

second_order_conservative

klimapy.statistics.interpolation.second_order_conservative(data, target_grid, *, source_grid=None)

源码

patch

klimapy.statistics.interpolation.patch(data, target_grid)

源码

统计分析 / EOF 与 SVD

svd

klimapy.statistics.svd(data, *, n_modes=None, tol=1e-12, max_sweeps=100)

源码

EOFResult

klimapy.statistics.EOFResult

EOFResult.reconstruct(self, n_modes=None, *, add_mean=True)

源码

eof

klimapy.statistics.eof(data, *, n_modes=None, weights=None, lat=None, center=True, ddof=1, tol=1e-12, max_sweeps=100)

源码

统计分析 / 空间统计

calculate_spatial_mean

klimapy.statistics.spatial.calculate_spatial_mean(data_array, method='arithmetic', include_zeros=False, shp=None)

源码

统计分析 / 气候态

climatology_period

klimapy.statistics.climatology_period(as_of_year=None)

源码

compute_climatology

klimapy.statistics.compute_climatology(data, *, variable=None, baseline_years=None, group='monthly', as_of_year=None, min_valid_fraction=0.9, time_chunk_size=128)

源码

辅助工具 / NetCDF

to_netcdf

klimapy.tools.to_netcdf(field, path)

源码

辅助工具 / GeoTIFF

to_geotiff

klimapy.tools.to_geotiff(nc_file, output_dir, clip_extent=None, variable=None, start_year=None, end_year=None)

源码

辅助工具 / CSV

to_csv

klimapy.tools.to_csv(field, path, *, missing_value='', value_column=None)

源码

批处理

process_models

klimapy.process_models(jobs, *, output_dir, strict=False, bc_options=None, sd_options=None)

源码

动态生成的 ETCCDI 指标

降水阈值类指标提供以下命名组合。完整口径与返回频率见 ETCCDI。

这里的 metric 代表所选函数名称，不是额外导出的函数。百分位降水必须显式提供基准期；温度百分位函数的 bootstrap 默认行为见其独立签名及指南。