Metadata-Version: 2.4
Name: mass_balance_module
Version: 1.0.0
Summary: DTC-IS module to fetch EO data and derive current and future mass balance predictions into the future.
License: MIT
License-File: LICENSE
Author: DTC-IS consortium
Author-email: support@dtc-ice-sheets.org
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Requires-Dist: cloudpickle (>=3.1.2,<4.0.0)
Requires-Dist: cyclopts (>=4.5.1,<5.0.0)
Requires-Dist: dask[array] (>=2026.8.0,<2027.0.0)
Requires-Dist: matplotlib (>=3.10.8,<4.0.0)
Requires-Dist: netcdf4 (>=1.7.4,<2.0.0)
Requires-Dist: numpy (>=2.3,<3.0)
Requires-Dist: requests (>=2.32.5,<3.0.0)
Requires-Dist: rioxarray (>=0.15.0,<0.22.0)
Requires-Dist: scipy (>=1.16.3,<2.0.0)
Requires-Dist: xarray (>=2025.12.0,<2026.0.0)
Requires-Dist: xgboost (>=3.2.0,<4.0.0)
Requires-Dist: zarr (>=3.1.5,<4.0.0)
Project-URL: Homepage, https://github.com/dtc-ice-sheets/mass_balance_module
Description-Content-Type: text/markdown

![Tests](https://github.com/dtc-ice-sheets/mass_balance_module/actions/workflows/mass_balance_module_test.yml/badge.svg)
![Deployment](https://github.com/dtc-ice-sheets/mass_balance_module/actions/workflows/mass_balance_module_deploy.yml/badge.svg)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/DTC-Ice-Sheets/mass_balance_module/blob/main/LICENSE)

# DTC-IS Mass Balance Module

The `mass_balance_module` is a sub-component of the
[Digital Twin Component for Ice Sheets (DTC-IS)](https://dtc-ice-sheets.org/), an ESA-funded, EO-driven digital twin project.

This software package fetches Earth Observation (EO) data and derives current and future mass balance predictions into the future.

For an in-depth overview of the mass_balance_module please [read the docs](https://dtc-ice-sheets.github.io/mass_balance_module/).

The documentation includes sections on:

1. [Getting started](https://dtc-ice-sheets.github.io/mass_balance_module/quick-start.html)
1. [Scientific overview](https://dtc-ice-sheets.github.io/mass_balance_module/overview.html)
1. [API reference](https://dtc-ice-sheets.github.io/mass_balance_module/api.html)

For a more interactive way of exploring the system, please visit the digital twin's [dashboard](https://dashboards.dtc-ice-sheets.org/).

## Installation for Use

You can install this package with pip:

``` bash
pip install mass_balance_module
```
