Metadata-Version: 2.1
Name: permamodel
Version: 0.2.1
Summary: Permafrost models with a Basic Model Interface
Author-email: Elchin Jafarov <elchin.jafarov@colorado.edu>, Scott Stewart <scotts@colorado.edu>, Kang Wang <kang.wang@colorado.edu>, Ethan Pierce <ethan.pierce@colorado.edu>, Irina Overeem <irina.overeem@colorado.edu>
Maintainer-email: Mark Piper <mark.piper@colorado.edu>, Eric Hutton <eric.hutton@colorado.edu>
License: MIT License
Project-URL: Homepage, https://permamodel.github.io
Project-URL: Repository, https://github.com/permamodel/permamodel
Keywords: bmi,component modeling,earth science,model coupling,numerical modeling,permafrost
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: affine
Requires-Dist: netCDF4
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: pyyaml
Requires-Dist: python-dateutil
Requires-Dist: toml
Requires-Dist: xarray
Provides-Extra: build
Requires-Dist: build ; extra == 'build'
Requires-Dist: twine ; extra == 'build'
Requires-Dist: zest.releaser ; extra == 'build'
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: nox ; extra == 'dev'
Provides-Extra: testing
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: coverage[toml] ; extra == 'testing'
Requires-Dist: coveralls ; extra == 'testing'

[![PyPI](https://img.shields.io/pypi/v/permamodel)](https://pypi.org/project/permamodel)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/permamodel.svg)](https://anaconda.org/conda-forge/permamodel)
[![Basic Model Interface](https://img.shields.io/badge/CSDMS-Basic%20Model%20Interface-green.svg)](https://bmi.readthedocs.io/)
[![Test](https://github.com/permamodel/permamodel/actions/workflows/test.yml/badge.svg)](https://github.com/permamodel/permamodel/actions/workflows/test.yml)
[![Coverage Status](https://coveralls.io/repos/github/permamodel/permamodel/badge.svg?branch=main)](https://coveralls.io/github/permamodel/permamodel?branch=main)

permamodel
==========

Permamodel is a collection of numerical permafrost models.
This repository contains source code and examples for two models:

* Frost number
* Ku

For more information,
see the project home page: https://permamodel.github.io.


Installation
------------

Permamodel can be installed with `pip`:
```
$ pip install permamodel
```
or with `conda`:
```
$ conda install -c conda-forge permamodel
```
We recommend installing permamodel into a Python virtual environment.

The MIT License (MIT)

Copyright (c) 2016 permamodel

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.
