🌍 climatrix¶

Climatrix is a flexible toolbox for sampling and reconstructing climate datasets.

It provides utilities and an xarray accessor that simplifies the workflow of working with climate data arrays — from preprocessing to statistical sampling.

👤 Author¶

Name: Jakub Walczak
GitHub: @jamesWalczak
Email: jakub.walczak@p.lodz.pl

👥 Contributors¶

Name: Wojciech Żyndul
GitHub: @wzyndul
Email: 242575@edu.p.lodz.pl

📌 Version¶

Alpha release

This is an alpha release – features are still evolving, and breaking changes may occur.

🚀 Getting Started¶

Climatrix is now available on PyPI

Run pip install climatrix to install.

These instructions will get you a copy of the project up and running on your local machine.

git clone https://github.com/jamesWalczak/climatrix/
cd climatrix

📦 Installation¶

PyPI Installation

The project is now available via PyPI (pip install climatrix)

⚙️ Usage¶

Here is a basic example of how to use this project. For more details, refer to API reference or Getting started section.

🧪 Examples¶

🔍 Click to expand example: Accessing `climatrix` features

import climatrix as cm
import xarray as xr

my_dataset = "/file/to/netcdf.nc"
cm_dset = xr.open_dataset(my_dataset).cm

📊 Click to expand example: Getting values of coordinate

import climatrix as cm
import xarray as xr

my_dataset = "/file/to/netcdf.nc"
cm_dset = xr.open_dataset(my_dataset).cm
print("Latitude values: ", cm_dset.latitude)
print("Time values: ", cm_dset.time)

📊 Subsetting by bounding box

import climatrix as cm
import xarray as xr

my_dataset = "/file/to/netcdf.nc"
cm_dset = xr.open_dataset(my_dataset).cm
europe = cm_dset.cm.subset(north=71, south=36, west=-24, east=35)

🛠️ Features¶

🧭 Easy access to coordinate data (similar to MetPy), using regex to locate lat/lon
📊 Sampling of climate data, both uniformly and using normal-like distributions
🔁 Reconstruction via:
IDW (Inverse Distance Weighting)
Ordinary Kriging
SIREN (Sinusoidal INR)
🧪 Tools to compare reconstruction results
📈 Plotting utilities for visualizing inputs and outputs

📄 License¶

This project is licensed under the MIT License - see the LICENSE file for details.

👥 Contributing¶

The rules for contributing on the project are described in CONTRIBUTING file in details.

🙏 Citation¶

If you are using this software in scientific work, cite us:

@article{walczak2025climatrix,
  title={Climatrix: Xarray accessor for climate data sampling and reconstruction},
  author={Walczak, Jakub and {\.Z}yndul, Wojciech},
  journal={SoftwareX},
  volume={31},
  pages={102263},
  year={2025},
  publisher={Elsevier}
}