Metadata-Version: 2.1
Name: craterslab
Version: 0.2.0
Summary: 
Home-page: https://github.com/gvieralopez/craters
License: MIT
Keywords: craters,depth maps,lidar,impacts
Author: Gustavo Viera López
Author-email: gvieralopez@gmail.com
Requires-Python: >=3.10,<3.12
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: keras (>=2.13.1,<3.0.0)
Requires-Dist: matplotlib (>=3.7.2,<4.0.0)
Requires-Dist: numpy (>=1.24.0,<2.0.0)
Requires-Dist: opencv-python (>=4.8.0,<5.0.0)
Requires-Dist: scikit-learn (>=1.3.0,<2.0.0)
Requires-Dist: scipy (>=1.11.1,<2.0.0)
Requires-Dist: tensorflow (>=2.13.0,<3.0.0)
Project-URL: Documentation, https://craterslab.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/gvieralopez/craters
Description-Content-Type: text/plain

# 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](https://www.python.org/downloads/) installed in your system.

### Installing craterslab from the repository using poetry (Recommended)

Make sure you have [poetry](https://python-poetry.org/docs/) 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. 

### Installing craterslab from pypi using pip

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](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) before installing the library.

## 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](https://craterslab.readthedocs.io/en/latest/) for more details.


