craterslab


Namecraterslab JSON
Version 0.2.8 PyPI version JSON
download
home_pagehttps://github.com/gvieralopez/craters
SummaryNone
upload_time2025-01-16 17:11:22
maintainerNone
docs_urlNone
authorGustavo Viera López
requires_python>=3.10
licenseMIT
keywords craters depth maps lidar impacts
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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 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](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/) before installing the library.

### Installing craterslab from the repository using poetry 
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. 

## 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.

## 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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/gvieralopez/craters",
    "name": "craterslab",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "craters, depth maps, lidar, impacts",
    "author": "Gustavo Viera L\u00f3pez",
    "author_email": "gvieralopez@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/75/45/38e0c011516b9a49049b3b2c6007c8c677bfd56eb3d27a3fb036acb35aad/craterslab-0.2.8.tar.gz",
    "platform": null,
    "description": "# Craters Morphology Analysis Tool\n\nA library to simplify the analysis of crater data from depth maps.\n\n## Installation\n\nCraterslab requires Python 3.10+ for functioning. Make sure you have a compliant version of [python](https://www.python.org/downloads/) installed in your system.\n\n### Installing craterslab from pypi using pip (Recommended)\n\n\nCraterslab is also available from pypi. You can install it by running:\n\n```\n$ pip install craterslab\n```\n\nWe 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.\n\n### Installing craterslab from the repository using poetry \nMake sure you have [poetry](https://python-poetry.org/docs/) in your system and then run:\n\n```\n$ git clone https://github.com/gvieralopez/craterslab.git\n$ cd craterslab\n$ poetry install\n$ poetry shell\n```\n\nThese will create and activate an isolated virtual environment with craterslab installed on it. \n\n## Usage\n\nYou can find some examples on how to use the library in this repository:\n\n```\n$ git clone https://github.com/gvieralopez/craterslab.git\n$ cd craterslab/examples\n```\n\nBefore executing any example, you will need to download data from actual craters using the provided scripts:\n\n```\n$ python download_data.py\n```\n\nThen, you can execute any given example as:\n\n```\n$ python example1.py\n```\n\nSee [software documentation](https://craterslab.readthedocs.io/en/latest/) for more details.\n\n## Troubleshooting\n\n### Error running the examples\n\nIf you get a warning as such\n\n```\nUserWarning: FigureCanvasAgg is non-interactive, and thus cannot be shown\n```\n\nYou may need to install tk on your operative system.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": null,
    "version": "0.2.8",
    "project_urls": {
        "Documentation": "https://craterslab.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/gvieralopez/craters",
        "Repository": "https://github.com/gvieralopez/craters"
    },
    "split_keywords": [
        "craters",
        " depth maps",
        " lidar",
        " impacts"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "be285aba26c40dca6b17ae5b99b881c605e5a5a9c82c83e6f7c3c5c47b0d2ce9",
                "md5": "bde8d562c0860590ea7f8643b58c85a0",
                "sha256": "ceb42d5dd28afd94de932b38e2356d8bfeb9af6a9bd480b873aac2f894a965d1"
            },
            "downloads": -1,
            "filename": "craterslab-0.2.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bde8d562c0860590ea7f8643b58c85a0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 23169691,
            "upload_time": "2025-01-16T17:11:10",
            "upload_time_iso_8601": "2025-01-16T17:11:10.617895Z",
            "url": "https://files.pythonhosted.org/packages/be/28/5aba26c40dca6b17ae5b99b881c605e5a5a9c82c83e6f7c3c5c47b0d2ce9/craterslab-0.2.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "754538e0c011516b9a49049b3b2c6007c8c677bfd56eb3d27a3fb036acb35aad",
                "md5": "8e60cbfe9980b5919686c0538f821971",
                "sha256": "4404b371689dd572a2a1c1cf65014a096585c8ab34ef45cb457ed2d1652f0180"
            },
            "downloads": -1,
            "filename": "craterslab-0.2.8.tar.gz",
            "has_sig": false,
            "md5_digest": "8e60cbfe9980b5919686c0538f821971",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 23161108,
            "upload_time": "2025-01-16T17:11:22",
            "upload_time_iso_8601": "2025-01-16T17:11:22.532711Z",
            "url": "https://files.pythonhosted.org/packages/75/45/38e0c011516b9a49049b3b2c6007c8c677bfd56eb3d27a3fb036acb35aad/craterslab-0.2.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-16 17:11:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gvieralopez",
    "github_project": "craters",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "craterslab"
}
        
Elapsed time: 8.22444s