| Name | climatrix JSON |
| Version |
1.0a7
JSON |
| download |
| home_page | None |
| Summary | Tool for climate data research |
| upload_time | 2025-07-30 12:30:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License
Copyright (c) 2025 Jakub Walczak
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.
|
| keywords |
climate
data
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# π climatrix
<div align="center">
<img src="https://raw.githubusercontent.com/jamesWalczak/climatrix/0e2a3ab98836642140e50f2e59e314134c61137f/docs/assets/logo.svg" width="200" alt="Climatrix Logo">
<br>
<!-- Badges -->
<a href="https://www.python.org/downloads">
<img src="https://img.shields.io/badge/-Python_3.12%7C3.13-blue?logo=python&logoColor=white" alt="Python Versions">
</a>
<a href="https://black.readthedocs.io/en/stable/">
<img src="https://img.shields.io/badge/Code%20Style-Black-black.svg?labelColor=gray" alt="Code Style: Black">
</a>
<a href="https://pycqa.github.io/isort/">
<img src="https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336" alt="Import Sort: isort">
</a>
<a href="https://github.com/jamesWalczak/climatrix/blob/main/LICENSE">
<img src="https://img.shields.io/badge/License-MIT-green.svg?labelColor=gray" alt="License: MIT">
</a>
</div>
______________________________________________________________________
**Climatrix** is a flexible toolbox for sampling and reconstructing climate datasets.
It provides utilities and an [xarray](https://docs.xarray.dev/en/latest/index.html) accessor that simplifies the workflow of working with climate data arrays β from preprocessing to statistical sampling.
______________________________________________________________________
## π€ Author
- **Name:** Jakub Walczak
- **GitHub:** [@jamesWalczak](https://github.com/jamesWalczak)
- **Email:** jakub.walczak@p.lodz.pl
______________________________________________________________________
## π₯ Contributors
- **Name:** Wojciech Ε»yndul
- **GitHub:** [@wzyndul](https://github.com/wzyndul)
- **Email:** 242575@edu.p.lodz.pl
______________________________________________________________________
## π Version
> **Important**
> This is an alpha release β features are still evolving, and breaking changes may occur.
______________________________________________________________________
## π Table of Contents
- [π Getting Started](#-getting-started)
- [π¦ Installation](#-installation)
- [βοΈ Usage](#%EF%B8%8F-usage)
- [π§ͺ Examples](#-examples)
- [π οΈ Features](#%EF%B8%8F-features)
- [π License](#-license)
- [π Citation](#-citation)
______________________________________________________________________
## βοΈ Usage
Getting started and API reference are available in the official [documentation](https://jameswalczak.github.io/climatrix/latest/).
______________________________________________________________________
## π§ͺ Examples
<details>
<summary>π Click to expand example: Accessing `climatrix` features</summary>
```python
import climatrix as cm
import xarray as xr
my_dataset = "/file/to/netcdf.nc
cm_dset = xr.open_dataset(my_dataset).cm
```
</details>
<details>
<summary>π Click to expand example: Getting values of coordinate</summary>
```python
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)
```
</details>
<details>
<summary>π Subsetting by bounding box</summary>
```python
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)
```
</details>
______________________________________________________________________
## π οΈ 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](https://github.com/jamesWalczak/climatrix/blob/main/LICENSE) file for details.
## π₯ Contributing
The rules for contributing on the project are described in [CONTRIBUTING](https://github.com/jamesWalczak/climatrix/blob/main/CONTRIBUTING.md) 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}},
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "climatrix",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "climate data",
"author": null,
"author_email": "Jakub Walczak <jakub.walczak@p.lodz.pl>, Wojciech \u017byndul <242575@edu.p.lodz.pl>",
"download_url": "https://files.pythonhosted.org/packages/85/37/342de878132da2d4b978b741707b2ecea4e782522c6d6ef5a96af95220fb/climatrix-1.0a7.tar.gz",
"platform": null,
"description": "# \ud83c\udf0d climatrix\n\n<div align=\"center\">\n\n<img src=\"https://raw.githubusercontent.com/jamesWalczak/climatrix/0e2a3ab98836642140e50f2e59e314134c61137f/docs/assets/logo.svg\" width=\"200\" alt=\"Climatrix Logo\">\n\n<br>\n\n<!-- Badges -->\n\n<a href=\"https://www.python.org/downloads\">\n <img src=\"https://img.shields.io/badge/-Python_3.12%7C3.13-blue?logo=python&logoColor=white\" alt=\"Python Versions\">\n</a>\n<a href=\"https://black.readthedocs.io/en/stable/\">\n <img src=\"https://img.shields.io/badge/Code%20Style-Black-black.svg?labelColor=gray\" alt=\"Code Style: Black\">\n</a>\n<a href=\"https://pycqa.github.io/isort/\">\n <img src=\"https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336\" alt=\"Import Sort: isort\">\n</a>\n<a href=\"https://github.com/jamesWalczak/climatrix/blob/main/LICENSE\">\n <img src=\"https://img.shields.io/badge/License-MIT-green.svg?labelColor=gray\" alt=\"License: MIT\">\n</a>\n\n</div>\n\n______________________________________________________________________\n\n**Climatrix** is a flexible toolbox for sampling and reconstructing climate datasets.\n\nIt provides utilities and an [xarray](https://docs.xarray.dev/en/latest/index.html) accessor that simplifies the workflow of working with climate data arrays \u2014 from preprocessing to statistical sampling.\n\n______________________________________________________________________\n\n## \ud83d\udc64 Author\n\n- **Name:** Jakub Walczak\n- **GitHub:** [@jamesWalczak](https://github.com/jamesWalczak)\n- **Email:** jakub.walczak@p.lodz.pl\n\n______________________________________________________________________\n\n## \ud83d\udc65 Contributors\n\n- **Name:** Wojciech \u017byndul\n- **GitHub:** [@wzyndul](https://github.com/wzyndul)\n- **Email:** 242575@edu.p.lodz.pl\n\n______________________________________________________________________\n\n## \ud83d\udccc Version\n\n> **Important**\n> This is an alpha release \u2013 features are still evolving, and breaking changes may occur.\n\n______________________________________________________________________\n\n## \ud83d\udcda Table of Contents\n\n- [\ud83d\ude80 Getting Started](#-getting-started)\n- [\ud83d\udce6 Installation](#-installation)\n- [\u2699\ufe0f Usage](#%EF%B8%8F-usage)\n- [\ud83e\uddea Examples](#-examples)\n- [\ud83d\udee0\ufe0f Features](#%EF%B8%8F-features)\n- [\ud83d\udcc4 License](#-license)\n- [\ud83d\ude4f Citation](#-citation)\n\n______________________________________________________________________\n\n## \u2699\ufe0f Usage\n\nGetting started and API reference are available in the official [documentation](https://jameswalczak.github.io/climatrix/latest/).\n\n______________________________________________________________________\n\n## \ud83e\uddea Examples\n\n<details>\n<summary>\ud83d\udd0d Click to expand example: Accessing `climatrix` features</summary>\n\n```python\nimport climatrix as cm\nimport xarray as xr\n\nmy_dataset = \"/file/to/netcdf.nc\ncm_dset = xr.open_dataset(my_dataset).cm\n```\n\n</details>\n\n<details>\n<summary>\ud83d\udcca Click to expand example: Getting values of coordinate</summary>\n\n```python\nimport climatrix as cm\nimport xarray as xr\n\nmy_dataset = \"/file/to/netcdf.nc\"\ncm_dset = xr.open_dataset(my_dataset).cm\nprint(\"Latitude values: \", cm_dset.latitude)\nprint(\"Time values: \", cm_dset.time)\n```\n\n</details>\n\n<details>\n<summary>\ud83d\udcca Subsetting by bounding box</summary>\n\n```python\nimport climatrix as cm\nimport xarray as xr\n\nmy_dataset = \"/file/to/netcdf.nc\ncm_dset = xr.open_dataset(my_dataset).cm\neurope = cm_dset.cm.subset(north=71, south=36, west=-24, east=35)\n```\n\n</details>\n\n______________________________________________________________________\n\n## \ud83d\udee0\ufe0f Features\n\n- \ud83e\udded Easy access to coordinate data (similar to MetPy), using regex to locate lat/lon\n- \ud83d\udcca Sampling of climate data, both **uniformly** and using **normal-like distributions**\n- \ud83d\udd01 Reconstruction via:\n - **IDW** (Inverse Distance Weighting)\n - **Ordinary Kriging**\n - **SIREN** (Sinusoidal INR)\n- \ud83e\uddea Tools to compare reconstruction results\n- \ud83d\udcc8 Plotting utilities for visualizing inputs and outputs\n\n______________________________________________________________________\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/jamesWalczak/climatrix/blob/main/LICENSE) file for details.\n\n## \ud83d\udc65 Contributing\n\nThe rules for contributing on the project are described in [CONTRIBUTING](https://github.com/jamesWalczak/climatrix/blob/main/CONTRIBUTING.md) file in details.\n\n______________________________________________________________________\n\n## \ud83d\ude4f Citation\n\nIf you are using this software in scientific work, cite us:\n\n```\n@misc{climatrix,\n author = {Walczak, J., \u017byndul, W.},\n title = {climatrix: Climate data reconstruction made simple },\n year = {2025},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/jamesWalczak/climatrix}},\n}\n```\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Jakub Walczak\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Tool for climate data research",
"version": "1.0a7",
"project_urls": null,
"split_keywords": [
"climate",
"data"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "15b88a049f5113b7756e09780b6dbf61a966a42bb613978862c90c57f50911c5",
"md5": "6fdad1d2e83275bc38a5122036724753",
"sha256": "2fe2f2f96c44d4e544d17511cdb70733a19422a868813feb3fa70ab71e899cf5"
},
"downloads": -1,
"filename": "climatrix-1.0a7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6fdad1d2e83275bc38a5122036724753",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 73708,
"upload_time": "2025-07-30T12:30:35",
"upload_time_iso_8601": "2025-07-30T12:30:35.550719Z",
"url": "https://files.pythonhosted.org/packages/15/b8/8a049f5113b7756e09780b6dbf61a966a42bb613978862c90c57f50911c5/climatrix-1.0a7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8537342de878132da2d4b978b741707b2ecea4e782522c6d6ef5a96af95220fb",
"md5": "78a107bb39f0ed308bf2a9f68d6d2df7",
"sha256": "68903bec9b1271c5ebc3172c2c96552c0e5e36727e0566093c7f3dcc6bee6f3f"
},
"downloads": -1,
"filename": "climatrix-1.0a7.tar.gz",
"has_sig": false,
"md5_digest": "78a107bb39f0ed308bf2a9f68d6d2df7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 5939618,
"upload_time": "2025-07-30T12:30:37",
"upload_time_iso_8601": "2025-07-30T12:30:37.556426Z",
"url": "https://files.pythonhosted.org/packages/85/37/342de878132da2d4b978b741707b2ecea4e782522c6d6ef5a96af95220fb/climatrix-1.0a7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 12:30:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "climatrix"
}
