Metadata-Version: 2.4
Name: samstars
Version: 0.2.0
Summary: Multimodal instance segmentation of individual trees
Author: Iosefa Percival
License-Expression: MIT
Project-URL: Documentation, https://samstars.sefa.ai
Project-URL: Repository, https://github.com/iosefa/samstars
Keywords: segmentation,remote-sensing,lidar,imagery,geospatial
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: <3.13,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: csbdeep>=0.8.1
Requires-Dist: geopandas>=1.0
Requires-Dist: numpy>=1.26
Requires-Dist: pandas>=2.0
Requires-Dist: pyogrio>=0.7.2
Requires-Dist: rasterio<1.5,>=1.4
Requires-Dist: scikit-image>=0.22
Requires-Dist: scikit-learn>=1.3
Requires-Dist: scipy>=1.11
Requires-Dist: segment-anything==1.0
Requires-Dist: shapely>=2.0
Requires-Dist: stardist>=0.9.1
Requires-Dist: tensorflow<2.19,>=2.15
Requires-Dist: torch<3,>=2.3
Requires-Dist: torchvision<1,>=0.18
Requires-Dist: tqdm>=4.66
Provides-Extra: metal
Requires-Dist: tensorflow-metal<2,>=1.2; (platform_system == "Darwin" and platform_machine == "arm64") and extra == "metal"
Provides-Extra: test
Requires-Dist: pytest>=8; extra == "test"
Provides-Extra: docs
Requires-Dist: mkdocs>=1.6; extra == "docs"
Requires-Dist: mkdocs-jupyter; extra == "docs"
Requires-Dist: mkdocs-material>=9.5; extra == "docs"
Requires-Dist: mkdocstrings>=1.0; extra == "docs"
Requires-Dist: mkdocstrings-python>=2.0; extra == "docs"
Requires-Dist: pymdown-extensions>=10.7; extra == "docs"
Dynamic: license-file

# samstars

[![PyPI](https://img.shields.io/pypi/v/samstars.svg)](https://pypi.org/project/samstars/)
[![Python](https://img.shields.io/pypi/pyversions/samstars.svg)](https://pypi.org/project/samstars/)
[![Tests](https://img.shields.io/github/actions/workflow/status/iosefa/samstars/ci.yml?branch=main&label=tests)](https://github.com/iosefa/samstars/actions/workflows/ci.yml)
[![Documentation](https://img.shields.io/github/actions/workflow/status/iosefa/samstars/docs.yml?branch=main&label=docs)](https://samstars.sefa.ai/)
[![Contributors](https://img.shields.io/github/contributors/iosefa/samstars.svg?label=contributors)](https://github.com/iosefa/samstars/graphs/contributors)
[![PyPI Downloads](https://static.pepy.tech/badge/samstars)](https://pepy.tech/projects/samstars)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

`samstars` is a Python library for instance segmentation of individual trees
using high-resolution imagery and lidar-derived rasters.

![SAM-STARS graphical abstract showing satellite imagery and lidar inputs, automatic crown prompts, canopy fusion, individual crown delineation, species classification, and annotation efficiency.](docs/assets/figures/sam-stars-graphical-abstract.png)

Read the full documentation at [samstars.sefa.ai](https://samstars.sefa.ai).

## Installation

Install from PyPI with Python 3.10–3.12:

```bash
python -m pip install samstars
```

See the [installation guide](https://samstars.sefa.ai/installation/) for
supported platforms and optional GPU setup.

## Developer setup

From a local clone:

```bash
python -m pip install -e .
```

To run the tests:

```bash
python -m pip install -e ".[test]"
python -m pytest
```

For documentation development:

```bash
python -m pip install -e ".[docs]"
mkdocs serve
```

Conda setup is covered in the
[installation guide](docs/installation.md#conda-development-environments).
