Welcome to heat1d’s documentation!

Contents:

heat1d

https://img.shields.io/pypi/v/heat1d.svg https://img.shields.io/travis/phayne/heat1d.svg Documentation Status

Thermal model for planetary science applications (Python version)

See the notebook for an example.

Features

  • Modeling 1D heat transfer in planetary surfaces
  • Provides library of required planetary surface parameters
  • Plotting helpers (see notebook)

Installation

pip install heat1d

Credits

Author: P. Hayne

Package maintainer: K.-Michael Aye

This package was created with Cookiecutter and the forked michaelaye/cookiecutter-pypackage-conda project template.

Installation

Stable release

To install heat1d, run this command in your terminal:

$ pip install heat1d

This is the preferred method to install heat1d, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for heat1d can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/phayne/heat1d

Or download the tarball:

$ curl  -OL https://github.com/phayne/heat1d/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use heat1d in a project:

import heat1d

Credits

Original Development

Package Maintainer

History

0.1.0 (2019-05-21)

  • First release on PyPI.

Indices and tables