Skip to content

Spectral recovery analysis for forested ecosystems in Python. Part of the PEOPLE-ER project.

License

Notifications You must be signed in to change notification settings

PEOPLE-ER/Spectral-Recovery

Repository files navigation

(pre-release) spectral-recovery

🛰️🌲📈 supporting spectral recovery analysis for forested ecosystems 📈🌲🛰️

PyPI version Binder Code style: black


Github: https://github.com/PEOPLE-ER/Spectral-Recovery/

Documentation: https://people-er.github.io/Spectral-Recovery/

PyPi: https://pypi.org/project/spectral-recovery/


‼️ The first stable release (1.0.0) of spectral-recovery is scheduled for 2024.04.30!


Overview

spectral-recovery is an open-source project and Python package that provides computationally simple, centralized, and reproducible methods for performing spectral recovery analysis of forests using satellite imagery.

The package provides straight-forward interfaces to help coordinate the many moving parts of spectral recovery analysis. Users provide restoration site locations, restoration dates, and annual composites of spectral data, while spectral-recovery handles computing the spectral indices, recovery targets, recovery metrics, and more!

The package aims, through both software and supplementary documentation, to make spectral recovery analysis more approachable, encouraging the use and adoption of well-founded remote sensing techniques to aid Ecosystem Restoration research and projects.

Installation

pip install spectral-recovery

Documentation

  • View background information, static tutorials, and API references in our project documentation.
  • Try out an interactive notebook: Binder

Contributing

  • Report bugs, suggest features, and see what others are saying on our GitHub Issues page.
  • Start discussions about the tool on our discussion page.
  • Want to contribute code? See our CONTRIBUTING document for more information.

How to Cite

Publication in progress. For now, when using this tool in your work we ask that you acknowledge as follows:

"spectral-recovery method developed in the PEOPLE-ER Project, managed by Hatfield Consultants, and financed by the European Space Agency."

License

Copyright 2023 Hatfield Consultants LLP

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http:https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.