Metadata-Version: 2.1
Name: pygem
Version: 1.0.4
Summary: Python Glacier Evolution Model (PyGEM)
License: MIT
Author: David Rounce
Author-email: drounce@cmu.edu>,Brandon Tober <btober@cmu.edu
Requires-Python: >=3.10,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: PyYAML (>=6.0.2,<7.0.0)
Requires-Dist: arviz (>=0.20.0,<0.21.0)
Requires-Dist: geopandas (>=1.0.1,<2.0.0)
Requires-Dist: gpytorch (>=1.13,<2.0)
Requires-Dist: jupyter (>=1.1.1,<2.0.0)
Requires-Dist: matplotlib (>=3.9.2,<4.0.0)
Requires-Dist: nbmake (>=1.5.5)
Requires-Dist: numpy (<2.0)
Requires-Dist: oggm (>=1.6.2,<2.0.0)
Requires-Dist: pandas (>=2.2.3,<3.0.0)
Requires-Dist: pyproj (>=3.7.0,<4.0.0)
Requires-Dist: pytest (>=8.3.4)
Requires-Dist: pytest-cov (>=6.0.0)
Requires-Dist: rasterio (>=1.4.2,<2.0.0)
Requires-Dist: ruamel-yaml (>=0.18.10,<0.19.0)
Requires-Dist: ruff (>=0.9.6)
Requires-Dist: salem (>=0.3.11,<0.4.0)
Requires-Dist: scikit-learn (>=1.5.2,<2.0.0)
Requires-Dist: scipy (>=1.14.1,<2.0.0)
Requires-Dist: tables (>=3.10.1,<4.0.0)
Requires-Dist: torch (>=2.0.0,<=2.2.2)
Requires-Dist: tqdm (>=4.66.6,<5.0.0)
Requires-Dist: xarray (>=2024.10.0,<2025.0.0)
Project-URL: Documentation, https://pygem.readthedocs.io/
Project-URL: Repository, https://github.com/PyGEM-Community/PyGEM
Description-Content-Type: text/markdown

## Python Glacier Evolution Model (PyGEM)

The Python Glacier Evolution Model (PyGEM) is an open-source glacier evolution model coded in Python that models the transient evolution of glaciers. Each glacier is modeled independently using a monthly timestep. PyGEM has a modular framework that allows different schemes to be used for model calibration or model physics (e.g., climatic mass balance, glacier dynamics).

Details concerning the model installation, physics, and more may be found at [pygem.readthedocs.io](https://pygem.readthedocs.io/en/latest/).

PyGEM versions prior to 1.0.0 are no longer actively supported.

***

### Model Testing

To support model testing and demonstration, a suite of Jupyter notebooks can be found within a separate [PyGEM-notebooks](https://github.com/PyGEM-Community/PyGEM-notebooks) repository. 

***

<table style="width: 100%;">
  <tr>
    <td style="width: 50%;"><b>Version</b></td>
    <td style="width: 50%;">
      <a href="https://pypi.python.org/pypi/pygem"><img src="https://img.shields.io/pypi/v/pygem.svg"></a>
      &nbsp;
      <a href="https://pypi.python.org/pypi/pygem"><img src="https://img.shields.io/pypi/pyversions/pygem.svg"></a>
    </td>
  </tr>
  <tr>
    <td style="width: 50%;"><b>Citation</b></td>
    <td style="width: 50%;">
      <a href="https://www.science.org/doi/10.1126/science.abo1324"><img src="https://img.shields.io/badge/citation-Rounce%20et%20al.%20(2023;%20Science)-orange.svg"></a>
      &nbsp;
      <a href="https://doi.org/10.5281/zenodo.15538452"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.15538452.svg" alt="DOI"></a>
    </td>
  </tr>
  <tr>
    <td style="width: 50%;"><b>License</b></td>
    <td style="width: 50%;">
      <a href="https://github.com/PyGEM-Community/PyGEM/blob/master/LICENSE.txt"><img src="https://img.shields.io/pypi/l/pygem.svg"></a>
    </td>
  </tr>
  <tr>
    <td style="width: 50%;"><b>Systems</b></td>
    <td style="width: 50%;">
      - Ubuntu 20.04, 22.04 <br>
      - Red Hat Enterprise Linux (RHEL) 8.8 <br>
      - macOS (Intel & Apple Silicon) <br>
      - <em>Note</em>, we suggest that Windows users install<br>PyGEM using either the Windows Subsystem<br>for Linux or Oracle VirtualBox
    </td>
  </tr>
</table>

