Metadata-Version: 2.4
Name: phytospatial
Version: 0.3.0
Summary: A python package to process remote sensing forestry data
Author-email: Louis-Vincent Grand'Maison <lvgra@ulaval.ca>
License-Expression: MIT OR Apache-2.0
Project-URL: Homepage, https://github.com/Louis-Gm/phytospatial
Project-URL: Bug Tracker, https://github.com/Louis-Gm/phytospatial/issues
Keywords: forestry,remote sensing,imagery,image processing,geospatial,GIS
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE-MIT
License-File: LICENSE-APACHE
License-File: NOTICE
Requires-Dist: geopandas
Requires-Dist: pandas
Requires-Dist: tqdm
Requires-Dist: rasterio>=1.4
Requires-Dist: numpy>=1.24
Provides-Extra: analysis
Requires-Dist: pyarrow>=10.0; extra == "analysis"
Requires-Dist: scikit-learn; extra == "analysis"
Requires-Dist: scipy; extra == "analysis"
Provides-Extra: docs
Requires-Dist: mkdocs>=1.5; extra == "docs"
Requires-Dist: mkdocs-material>=9.5; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
Requires-Dist: mkdocs-include-markdown-plugin>=4.0; extra == "docs"
Requires-Dist: mkdocs-jupyter>=0.24; extra == "docs"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Dynamic: license-file

<br />
<div align="center">
  <a href="https://github.com/Louis-Gm/phytospatial">
    <img src="https://raw.githubusercontent.com/Louis-Gm/phytospatial/main/assets/phytospatial.png" alt="Logo" width="420" height="420">
  </a>
  <h1 align="center"><b>phytospatial</b></h1>
  <p align="center">
    A python package to process remote sensing data in forestry applications
  </p>

  [start]: #

  <p align="center">
    <a href="https://phytospatial.readthedocs.io/"><strong>Explore the docs »</strong></a>
  </p>
 
  [end]: #

  <p>
    <a href="https://github.com/Louis-Gm/phytospatial/issues">Report Bug</a>
    ·
    <a href="https://github.com/Louis-Gm/phytospatial/issues">Request Feature</a>
  </p>
  <p align="center">
    <img src="https://img.shields.io/badge/python-3.10+-orange.svg" alt="Python versions">    
    <img src="https://img.shields.io/badge/License-MIT%20or%20Apache%202.0-blue.svg" alt="License">
    <img src="https://img.shields.io/badge/DOI-10.5281%2Fzenodo.18112045-purple" alt="DOI">
    <br />
    <img src="https://github.com/Louis-Gm/phytospatial/actions/workflows/test_suite.yml/badge.svg" alt="Build Status">
  </p>
</div>

## About The Project

**Phytospatial** is a Python toolkit designed to streamline the processing of remote sensing data for forestry and vegetation analysis. It provides tools for handling large hyperspectral rasters, validating vector geometries, and extracting spectral statistics from tree crowns. It also allows for passive-active raster-level fusion via its image processing module.

### Key Features

* **Memory-Safe Processing:** Process massive rasters using windowed reading (via `rasterio`) without overloading RAM.
* **Forestry Focused:** Specialized tools for tree crown validation and species labeling.
* **Dual-Licensed:** Available under both MIT and Apache 2.0 licenses for maximum flexibility.

## Getting Started

### Installation

To get up and running quickly with `pip`:

```sh
git clone https://github.com/Louis-Gm/phytospatial.git
cd phytospatial
pip install -e .
```

> **New to Python?** Check out our detailed [Installation Guide](https://phytospatial.readthedocs.io/en/latest/installation/) for Conda and Virtual Environment setup.

## Usage

Here is a simple example of extracting spectral data from tree crowns:

```python
from phytospatial import extract, loaders

# Load tree crowns
crowns = loaders.load_crowns("data/crowns.shp")

# Initialize extractor
extractor = extract.BlockExtractor("data/image.tif")

# Process
results = []
for stats in extractor.process_crowns(crowns):
    results.append(stats)
```

For a complete workflow, see the [Introduction Pipeline Tutorial](https://phytospatial.readthedocs.io/en/latest/examples/intro_pipeline/).

## Contribute

As an open-source project, we encourage and welcome contributions of students, researchers, or professional developers.

**Want to help?** Please read our [CONTRIBUTING](https://phytospatial.readthedocs.io/en/latest/contributing/contributing/) section for a detailed explanation of how to submit pull requests. Please also make sure to read the project's [CODE OF CONDUCT](https://phytospatial.readthedocs.io/en/latest/contributing/code_of_conduct/).

Not sure how to implement your idea, but want to contribute?
<br />
Feel free to leave a feature request <a href="https://github.com/Louis-Gm/phytospatial/issues">here</a>.

## Citation

If you use this project in your research, please cite it as:

Grand'Maison, L.-V. (2026). Phytospatial (0.3.0). Zenodo. https://doi.org/10.5281/zenodo.18112045

## Contact

The project is currently being maintained by **Louis-Vincent Grand'Maison**.

Feel free to contact me by email or linkedin:
<br />
Email - [lvgra@ulaval.ca](mailto:lvgra@ulaval.ca)
<br />
Linkedin - [grandmaison-lv](https://www.linkedin.com/in/grandmaison-lv/)

## Acknowledgments & Funding

This software is developed by Louis-Vincent Grand'Maison as part of a PhD project. The maintenance and development of this project is supported by several research scholarships:

* Fonds de recherche du Québec – Nature et technologies (FRQNT) (Scholarship 2024-2025)
* Natural Sciences and Engineering Research Council of Canada (NSERC) (Scholarship 2025-present)
* Université Laval (Scholarship 2024-present)

## License

`phytospatial` is distributed under the Apache License, Version 2.0 or the MIT License, at your option.

Unless you explicitly state otherwise, any contribution you intentionally submit for inclusion in this repository (as defined by Apache-2.0) shall be dual-licensed as above, without any additional terms or conditions.

See [LICENSE](https://phytospatial.readthedocs.io/en/latest/license/) for more information on licensing and copyright.

[start]: #

([Back to Top](#table-of-contents))

[end]: #
