Metadata-Version: 2.2
Name: treepoints
Version: 0.1.4
Summary: A Python library with a TensorFlow model for building a tree database from remote sensing data.
Home-page: https://github.com/sizhuoli/treePoints
Author: Sizhuo Li
Author-email: sizli@ign.ku.dk
License: Apache License 2.0
Keywords: tree detection,remote sensing,deep learning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: tensorflow[and-cuda]==2.15.1
Requires-Dist: keras==2.15.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# treePoints

A python package to build a tree database from remote sensing data.


![Build Status](https://img.shields.io/badge/build-passing-green)
![Python Version](https://img.shields.io/badge/python-3.11-blue)
![License](https://img.shields.io/badge/Apache-2.0-blue)
![Release](https://img.shields.io/badge/release-v0.1.3-orange)
![PyPI version](https://img.shields.io/pypi/v/treepoints)

## Table of Contents

- [Installation](#installation)
- [Demo Usage](#demo-usage)
- [Features](#features)
- [Acknowledgements](#acknowledgements)


## Installation

To install the package, follow instructions below.

### Step 1: Create a Specific Conda Environment

1. First, ensure that Conda is installed on your system.
2. Download the required conda environment file `environment.yml` from this GitHub [repository](https://github.com/sizhuoli/treePoints).
3. Create the Conda environment using the `environment.yml` file:

```bash
conda env create -f environment.yml
```

### Step 2: Activate the Conda Environment

After creating the Conda environment, activate it using the following command:

```bash
conda activate tf2151full_treepoints
```

### Step 3: Install the Package

#### Option 1: Install the Package from PyPI

* ( install the package directly, see deployment structure in test_example/ )

```
pip install treePoints
# pip install -i https://test.pypi.org/simple/ treepoints
```

#### Option 2: Install the Package from a cloned [repository](https://github.com/sizhuoli/treePoints):

* ( clone to run demo test examples )

```bash
git clone https://github.com/sizhuoli/treePoints.git
cd treePoints
pip install .
```


## Demo Usage

See [repository](https://github.com/sizhuoli/treePoints).

```bash
python test_example/demo_predict.py
```

Set configs in test_example/config/hyperps.yaml


## Features
..

## Acknowledgements
..
