Skip to main content

Permafrost models with a Basic Model Interface

Project description

Test Coverage Status

Permamodel

Permamodel is a collection of numerical permafrost models with a range of capability and complexity. Permamodel includes multiple sets of sample inputs representing a variety of conditions and locations. The Permamodel project is intended to facilitate the broader use of permafrost models. We hope that the simple Python interfaces and open source licensing can make permafrost models accessible to a broad audience well beyond the permafrost research community, such as educators, students, and policy makers.

Frost number

Calculates the frost number, an indication of the probability of finding permafrost, at a site. There are different versions of the frost number depending on what data area available at the site.

  • The air frost number requires some indication of the annual temperature cycle.
  • The surface frost number also requires indication of the year's precipitation.
  • The Stefan frost number additionally incorporates soil information.

Ku

Implements a semi-empirical/analytical solution to soil conditions. Please cite:

Wang, K., Jafarov, E., & Overeem, I. (2020). Sensitivity evaluation of the Kudryavtsev permafrost model. Science of The Total Environment, 137538. https://doi.org/10.1016/j.scitotenv.2020.137538

Overeem, I., E. Jafarov, K. Wang, K. Schaefer, S. Stewart, G. Clow, M. Piper, and Y. Elshorbany (2018). A modeling toolbox for permafrost landscapes. Eos. https://doi.org/10.1029/2018EO105155.

GIPL

GIPL is a numerical model that solves for the temperature profile of a soil column given its material properties and the temperature and precipitation conditions it experiences. For more information please see https://github.com/Elchin/GIPL and https://github.com/permamodel/GIPL-BMI-Fortran.

Installation

Permamodel can be installed with pip:

$ pip install permamodel

or with conda:

$ conda install -c conda-forge permamodel

We recommend installing permaodel into 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

permamodel-0.2.tar.gz (8.2 MB view hashes)

Uploaded Source

Built Distribution

permamodel-0.2-py3-none-any.whl (8.2 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page