> For the complete documentation index, see [llms.txt](https://yarroudh.gitbook.io/segment-lidar/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yarroudh.gitbook.io/segment-lidar/getting-started.md).

# Getting started

## About

The package **segment-lidar** is specifically designed for unsupervised instance segmentation of aerial LiDAR data. It brings together the power of Segment-Anything Model (SAM) developed by Meta Research and segment-geospatial package from Open Geospatial Solutions. Whether you're a researcher, developer, or a geospatial enthusiast, segment-lidar opens up new possibilities for automatic processing of aerial LiDAR data and enables further applications. We encourage you to explore our code, contribute to its development and leverage its capabilities for your segmentation tasks. If you use this package for your research, please cite:

```
@misc{yarroudh:2023:samlidar,
   author = {Yarroudh, Anass},
   title = {LiDAR Automatic Unsupervised Segmentation using Segment-Anything Model (SAM) from Meta AI},
   year = {2023},
   howpublished = {GitHub Repository},
   url = {https://github.com/Yarroudh/segment-lidar}
}
```

{% hint style="info" %}
The paper will be published very soon.
{% endhint %}

The latest source code is available at [GitHub](https://github.com/Yarroudh/segment-lidar). The package builds on top of existing works and when using specific algorithms within segment-lidar, please also cite the original authors, as specified in the source code.

## Contents

* [Installation](/segment-lidar/installation.md)
* [Basic tutorial](/segment-lidar/tutorial/basic-usage.md)
  * [Prerequisities](/segment-lidar/tutorial/prerequisites.md)
  * [Sample data](/segment-lidar/tutorial/sample-data.md)
  * [Basic usage](/segment-lidar/tutorial/basic-usage.md)
  * [Configuration](/segment-lidar/tutorial/configuration.md)
* [Citation](/segment-lidar/information/citation.md)
* [License](/segment-lidar/information/license.md)

## Support

Please, contact as via email <ayarroudh@uliege.be> or <akharroubi@uliege.be> for questions and the [GitHub issue tracker](https://github.com/Yarroudh/segment-lidar) for bug reports, feature requests, additions, enhancements and other topics.
