🌍 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.

---

📚 Table of Contents

• 🚀 Getting Started
• 📦 Installation
• ⚙️ Usage
• 🧪 Examples
• 🛠️ Features
• 📄 License
• 🙏 Citation

---

🚀 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

---

⚙️ 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

# TODO

---

🛠️ 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
• SiNET (Sinusoidal reconstruction)
• 🧪 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:

@misc{climatrix,
  author       = {Walczak, J., Żyndul, W.},
  title        = {climatrix: Climate data reconstruction made simple },
  year         = {2025},
  publisher    = {GitHub},
  journal      = {GitHub repository},
  howpublished = {\url{https://github.com/jamesWalczak/climatrix}},
}