Craters Morphology Analysis Tool

A library to simplify the analysis of crater data from depth maps.

Installation

Craterslab requires Python 3.10+ for functioning. Make sure you have a compliant version of python installed in your system.

Installing craterslab from pypi using pip (Recommended)

Craterslab is also available from pypi. You can install it by running:

$ pip install craterslab

We strongly encourage users using this method to create a virtual environment before installing the library.

Installing craterslab from the repository using poetry

Make sure you have poetry in your system and then run:

$ git clone https://github.com/gvieralopez/craterslab.git
$ cd craterslab
$ poetry install
$ poetry shell

These will create and activate an isolated virtual environment with craterslab installed on it.

Usage

You can find some examples on how to use the library in this repository:

$ git clone https://github.com/gvieralopez/craterslab.git
$ cd craterslab/examples

Before executing any example, you will need to download data from actual craters using the provided scripts:

$ python download_data.py

Then, you can execute any given example as:

$ python example1.py

See software documentation for more details.

Troubleshooting

Error running the examples

If you get a warning as such

UserWarning: FigureCanvasAgg is non-interactive, and thus cannot be shown

You may need to install tk on your operative system.