Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

REL: Version 1.0.0 release #154

Merged
merged 3 commits into from
Aug 29, 2024
Merged

REL: Version 1.0.0 release #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ca3c81
Bump version number to 1.0
szwiep Aug 29, 2024
3525309
Update CHANGELOG
szwiep Aug 29, 2024
35d5485
Remove release notice from README
szwiep Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- N/A


## [1.0.0] - 2024-08-29

### Added

- Add support for processing multiple restoration sites at once (#136)
- Add GCI, TCW, and TCG indexes (#138)
- Add support for index inputs to read_timeseries (#139)
- Add badge for tests status to README (#150)
- Add citation file to repository (#135)
- Add support for non-continuous timeseries inputs to read_timeseries (#129)
- Allow users to pass dict of TIF paths to read_timeseries (#130)
- Cast int inputs to float automatically in read_timeseries (#128)
- Add "quick start" section to README (#146)
- Add demo/example data accessible through data module (#143)

### Changed

- Change compute_metrics return from Xarray to dict of Xarray with restoration site ID as keys (#148)
- Refactor recovery metrics to accept only necessary arguments (#148)
- Change recovery targets return from Xarray dict of Xarray with restoration site ID as keys
- Recovery target module refactored into targets.historic and targets.reference sub-modules (#136)
- Update docstrings and API documentation (#149)
- Silence expected runtime warnings from Dask in metric computation (#147)

## Removed

- Remove support for CLI (#137)

### Fixed

- Fix broken spectral-recovery links in documentation (#142)



## [0.4.1] - 2024-04-16

### Fixed
Expand Down
4 changes: 0 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@ Documentation: [https://people-er.github.io/spectral-recovery/](https://people-e

PyPi: [https://pypi.org/project/spectral-recovery/](https://pypi.org/project/spectral-recovery/)

---
:bangbang: The first stable release (1.0.0) of spectral-recovery is scheduled for 2024.08.30!

---
## Overview

`spectral-recovery` is an open-source project and Python package that provides simple, centralized, and reproducible methods for performing [spectral recovery analysis](https://people-er.github.io/spectral-recovery/about/#13-looking-at-recovery-trajectories) to support [Ecosystem Restoration](https://people-er.github.io/spectral-recovery/about/#11-ecosystem-restoration) (ER) efforts in forested ecosystems.
Expand Down
5 changes: 1 addition & 4 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ classifiers = [
"Development Status :: 4 - Beta",
"Programming Language :: Python"
]
version = "0.4.1"
version = "1.0"
dependencies = [
"geopandas >= 0.13.2",
"rioxarray >= 0.14.1",
Expand Down Expand Up @@ -56,6 +56,3 @@ exclude = ["tests*"]

[tool.setuptools.package-data]
spectral_recovery = ["resources/*.json", "data/*.gpkg", "data/bc06_wildfire_landsat_BAP/*"]

[project.scripts]
specrec = "scripts.cli:cli"
Loading