Roughness

Illumination of rough planetary surfaces.

A python package for predicting the thermal emission from anisothermal rough planetary surfaces.

Documentation

See full documentation at nau-pixel.github.io/roughness

See usage examples at nau-pixel.github.io/roughness/examples

Installation

To clone and run the package, you'll need Git and Poetry installed on your computer.

# Clone this repository
$ git clone [email protected]:NAU-PIXEL/roughness.git

# Enter the repository
$ cd roughness

# Install dependencies into a venv with poetry
$ poetry install

# Run setup script (may take awhile)
$ poetry run python setup_roughness.py

# Now you can open a Jupyter server...
$ poetry run python jupyter notebook

# or activate the venv directly from the terminal...
$ poetry shell
$ python

# or activate the venv from your favorite IDE
# The venv is located at ~/roughness/.venv/bin/python

Contribute

This package is a work in progress. We appreciate any and all contributions in the form of bug reports & feature requests on our issues page, or as pull requests (see contributing guide for more details).

References and citation

This package is adapted from code by the late Dr. J. L. Bandfield. You can read more about the first iterations of this code in Bandfield et al. (2015) and Bandfield et al. (2018).

Please cite this software using the DOI of the latest version provided on Zenodo.

License

MIT. Learn more here.

Copyright (c) 2023, Christian J. Tai Udovicic