Metadata-Version: 2.4
Name: BERATools
Version: 0.3.9
Summary: An advanced forest line feature analysis platform
Project-URL: Homepage, https://github.com/appliedgrg/beratools
Author-email: AppliedGRG <appliedgrg@gmail.com>, Richard Zeng <richardqzeng@gmail.com>
License: GPL-3.0-or-later
License-File: LICENSE
Keywords: BERA,Line
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: gdal; platform_system != 'Windows'
Requires-Dist: geopandas
Requires-Dist: networkit
Requires-Dist: pandarallel
Requires-Dist: pyogrio>=0.9.0
Requires-Dist: pyqt5
Requires-Dist: rasterio
Requires-Dist: scikit-image>=0.24.0
Requires-Dist: tabulate
Requires-Dist: tqdm
Requires-Dist: xarray-spatial
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: isort; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-qt; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: tox; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: doc
Requires-Dist: click==8.2.1; extra == 'doc'
Requires-Dist: mkdocs; extra == 'doc'
Requires-Dist: mkdocs-git-revision-date-localized-plugin; extra == 'doc'
Requires-Dist: mkdocs-material; extra == 'doc'
Requires-Dist: mkdocstrings; extra == 'doc'
Requires-Dist: mkdocstrings-python; extra == 'doc'
Requires-Dist: pymdown-extensions; extra == 'doc'
Provides-Extra: test
Requires-Dist: gdal==3.8.4; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-qt; extra == 'test'
Requires-Dist: pywinauto; (platform_system == 'Windows') and extra == 'test'
Description-Content-Type: text/markdown

# BERA Tools

BERA Tools is successor of [Forest Line Mapper](https://github.com/appliedgrg/flm). It is a toolset for enhanced delineation and attribution of linear disturbances in forests.

<div align="center">

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/appliedgrg/beratools/python-tests.yml?branch=main)](https://github.com/appliedgrg/beratools/actions/workflows/python-tests.yml)
[![Codecov](https://img.shields.io/codecov/c/github/appliedgrg/beratools/main)](https://codecov.io/gh/appliedgrg/beratools)
[![GitHub Pages](https://img.shields.io/github/deployments/appliedgrg/beratools/github-pages?label=docs)](https://appliedgrg.github.io/beratools/)
[![Conda Version](https://img.shields.io/conda/v/AppliedGRG/beratools)](https://anaconda.org/AppliedGRG/beratools)
[![PyPI](https://img.shields.io/pypi/v/BERATools)](https://pypi.org/project/BERATools/)
[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/release/python-3100/)
[![License: GPL-3.0](https://img.shields.io/badge/License-GPL%203.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

</div>

## [Quick Start](https://appliedgrg.github.io/beratools)

Here are the ways to install BERA Tools:

- Windows installer
- Install with Anaconda.

### Windows Installer

Windows installer is provided with releases. Check the [latest release](https://github.com/appliedgrg/beratools/releases/latest).

### Install with Anaconda

Install with Anaconda works on Windows, macOS, and Linux.

- Install Miniconda. Download Miniconda from [Miniconda](https://docs.anaconda.com/miniconda/) and install on your machine.
- Download and save the file [environment.yml](https://raw.githubusercontent.com/appliedgrg/beratools/main/environment.yml
).
- Launch **Anaconda Prompt** and **Change directory** to where environment.yml is saved.
- Run the command to install BERA Tools.

   ```bash
   $ conda env create -n bera -f environment.yml
   ```

   After the installation is done, a new environment named **bera** is created and BERA Tools is installed within it.
- Activate the **bera** environment and launch BERA Tools main GUI:

  ```bash
  $ conda activate bera
  $ beratools gui
  ```

![BERA Tools Main GUI](beratools/gui/assets/BERA_GUI_Main.png)

- [Download latest example data](https://github.com/appliedgrg/beratools/releases/latest/download/test_data.zip) to try with BERA Tools.

For more information about installation, check the [BERA Tools Installation](https://appliedgrg.github.io/beratools/user/installation/).

## BERA Tools Guide

Check the online [BERA Tools Guide](https://appliedgrg.github.io/beratools/) for user, developer and technical guides.

## Credits

<table>
  <tr>
    <td><img src="https://github.com/appliedgrg/beratools/raw/main/docs/files/icons/bera_logo.png" alt="Logos" width="80"></td>
    <td>
      <p>
        This tool is part of the <strong><a href="http://www.beraproject.org/">Boreal Ecosystem Recovery & Assessment (BERA)</a></strong>.
        It is actively developed by the <a href="https://www.appliedgrg.ca/"><strong>Applied Geospatial Research Group</strong></a>.
      </p>
      <p>
        © 2026 Applied Geospatial Research Group. All rights reserved.
      </p>
    </td>
  </tr>
</table>
