diff --git a/.gitignore b/.gitignore index 1a06bc7..dbfa4a1 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ private/ *.py[cod] *$py.class *.nc +changelog_update.md # C extensions *.so diff --git a/docs/changelog.md b/docs/changelog.md index 289e2c5..935b48d 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,11 +1,224 @@ # Changelog -## v0.0.1 - Date +## v0.6.3 - Jul 1, 2024 -**Improvement**: +**What's Changed** -- TBD +- Update pace_chla_to_image_function by @giswqs in [#69](https://github.com/opengeos/HyperCoast/pull/69) -**New Features**: +**Full Changelog**: [v0.6.2...v0.6.3](https://github.com/opengeos/HyperCoast/compare/v0.6.2...v0.6.3) -- TBD +## v0.6.2 - Jun 30, 2024 + +**What's Changed** + +- Add search_datasets function and improve notebook example by @giswqs in [#66](https://github.com/opengeos/HyperCoast/pull/66) +- Add PACE OCI Level-1 notebook example by @giswqs in [#67](https://github.com/opengeos/HyperCoast/pull/67) +- Add PACE pixel location function by @giswqs in [#68](https://github.com/opengeos/HyperCoast/pull/68) + +**Full Changelog**: [v0.6.1...v0.6.2](https://github.com/opengeos/HyperCoast/compare/v0.6.1...v0.6.2) + +## v0.6.1 - Jun 30, 2024 + +**What's Changed** + +- Add more demos to docs by @giswqs in [#63](https://github.com/opengeos/HyperCoast/pull/63) +- Fix typos by @giswqs in [#64](https://github.com/opengeos/HyperCoast/pull/64) +- Add support for reading PACE OCI L2 data by @giswqs in [#65](https://github.com/opengeos/HyperCoast/pull/65) + +**Full Changelog**: [v0.6.0...v0.6.1](https://github.com/opengeos/HyperCoast/compare/v0.6.0...v0.6.1) + +## v0.6.0 - Jun 26, 2024 + +**What's Changed** + +- Add support for PACE Chlorophyll data by @giswqs in [#62](https://github.com/opengeos/HyperCoast/pull/62) + +**Full Changelog**: [v0.5.5...v0.6.0](https://github.com/opengeos/HyperCoast/compare/v0.5.5...v0.6.0) + +## v0.5.5 - Jun 25, 2024 + +**What's Changed** + +- Add image slicing demos to docs by @giswqs in [#56](https://github.com/opengeos/HyperCoast/pull/56) +- Add dependabot by @giswqs in [#58](https://github.com/opengeos/HyperCoast/pull/58) +- Bump nwtgck/actions-netlify from 2.0 to 3.0 by @dependabot in [#59](https://github.com/opengeos/HyperCoast/pull/59) +- Bump conda-incubator/setup-miniconda from 2 to 3 by @dependabot in [#60](https://github.com/opengeos/HyperCoast/pull/60) +- Add ERA5 temperature data notebook by @giswqs in [#61](https://github.com/opengeos/HyperCoast/pull/61) + +**New Contributors** + +- @dependabot made their first contribution in [#59](https://github.com/opengeos/HyperCoast/pull/59) + +**Full Changelog**: [v0.5.4...v0.5.5](https://github.com/opengeos/HyperCoast/compare/v0.5.4...v0.5.5) + +## v0.5.4 - Jun 14, 2024 + +**What's Changed** + +- Add support for interactive slicing by @giswqs in [#54](https://github.com/opengeos/HyperCoast/pull/54) +- Add image slicing notebook example by @giswqs in [#55](https://github.com/opengeos/HyperCoast/pull/55) + +**Full Changelog**: [v0.5.3...v0.5.4](https://github.com/opengeos/HyperCoast/compare/v0.5.3...v0.5.4) + +## v0.5.3 - Jun 12, 2024 + +**What's Changed** + +- Add EMIT image cube example by @giswqs in [#51](https://github.com/opengeos/HyperCoast/pull/51) +- Refactor read_neon() function to support generalized NEON data reading by @gponce-ars in [#52](https://github.com/opengeos/HyperCoast/pull/52) + +**New Contributors** + +- @gponce-ars made their first contribution in [#52](https://github.com/opengeos/HyperCoast/pull/52) + +**Full Changelog**: [v0.5.2...v0.5.3](https://github.com/opengeos/HyperCoast/compare/v0.5.2...v0.5.3) + +## v0.5.2 - Jun 11, 2024 + +**What's Changed** + +- Fix RGB image reshape bug for image cube by @giswqs in [#49](https://github.com/opengeos/HyperCoast/pull/49) + +**Full Changelog**: [v0.5.1...v0.5.2](https://github.com/opengeos/HyperCoast/compare/v0.5.1...v0.5.2) + +## v0.5.1 - Jun 11, 2024 + +**What's Changed** + +- Add support for 3D visualization by @giswqs in [#47](https://github.com/opengeos/HyperCoast/pull/47) +- Add image cube demo to docs by @giswqs in [#48](https://github.com/opengeos/HyperCoast/pull/48) + +**Full Changelog**: [v0.5.0...v0.5.1](https://github.com/opengeos/HyperCoast/compare/v0.5.0...v0.5.1) + +## v0.5.0 - Jun 10, 2024 + +**What's Changed** + +- Add support for NEON AOP data by @giswqs in [#43](https://github.com/opengeos/HyperCoast/pull/43) +- Add support for AVIRIS data by @giswqs in [#44](https://github.com/opengeos/HyperCoast/pull/44) +- Add support for changing band combinations and colormaps interactively by @giswqs in [#46](https://github.com/opengeos/HyperCoast/pull/46) + +**Full Changelog**: [v0.4.0...v0.5.0](https://github.com/opengeos/HyperCoast/compare/v0.4.0...v0.5.0) + +## v0.4.0 - Jun 3, 2024 + +**What's Changed** + +- Add support for searching and downloading ECOSTRESS data by @giswqs in [#37](https://github.com/opengeos/HyperCoast/pull/37) +- Add support for visualizing DESIS hyperspectral data by @giswqs in [#38](https://github.com/opengeos/HyperCoast/pull/38) + +**Full Changelog**: [v0.3.3...v0.4.0](https://github.com/opengeos/HyperCoast/compare/v0.3.3...v0.4.0) + +## v0.3.3 - May 19, 2024 + +**What's Changed** + +- Add functions for searching PACE and EMIT data by @giswqs in [#34](https://github.com/opengeos/HyperCoast/pull/34) +- Add stacking for spectral signatures by @giswqs in [#35](https://github.com/opengeos/HyperCoast/pull/35) + +**Full Changelog**: [v0.3.2...v0.3.3](https://github.com/opengeos/HyperCoast/compare/v0.3.2...v0.3.3) + +## v0.3.2 - May 10, 2024 + +**What's Changed** + +- Fix wavelength bug by @giswqs in [#27](https://github.com/opengeos/HyperCoast/pull/27) +- Pin xarray version by @giswqs in [#28](https://github.com/opengeos/HyperCoast/pull/28) +- Fix xr merge error by @giswqs in [#29](https://github.com/opengeos/HyperCoast/pull/29) + +**Full Changelog**: [v0.3.1...v0.3.2](https://github.com/opengeos/HyperCoast/compare/v0.3.1...v0.3.2) + +## v0.3.1 - May 9, 2024 + +**Full Changelog**: [v0.3.0...v0.3.1](https://github.com/opengeos/HyperCoast/compare/v0.3.0...v0.3.1) + +## v0.3.0 - May 8, 2024 + +**What's Changed** + +- Add filter_pace function by @giswqs in [#21](https://github.com/opengeos/HyperCoast/pull/21) +- Add grid pace function by @giswqs in [#22](https://github.com/opengeos/HyperCoast/pull/22) +- Add fetch depth for docs by @giswqs in [#23](https://github.com/opengeos/HyperCoast/pull/23) +- Add support for multi-band visualization by @giswqs in [#24](https://github.com/opengeos/HyperCoast/pull/24) +- Add extract_pace function by @giswqs in [#25](https://github.com/opengeos/HyperCoast/pull/25) +- Add spectral signature viz for PACE data by @giswqs in [#26](https://github.com/opengeos/HyperCoast/pull/26) + +**Full Changelog**: [v0.2.0...v0.3.0](https://github.com/opengeos/HyperCoast/compare/v0.2.0...v0.3.0) + +## v0.2.0 - May 5, 2024 + +**What's Changed** + +- Add support for reading and visualizing PACE data by @giswqs in [#20](https://github.com/opengeos/HyperCoast/pull/20) + +**Full Changelog**: [v0.1.3...v0.2.0](https://github.com/opengeos/HyperCoast/compare/v0.1.3...v0.2.0) + +## v0.1.3 - Apr 30, 2024 + +**What's Changed** + +- Move hvplot import into functions by @giswqs in [#18](https://github.com/opengeos/HyperCoast/pull/18) +- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in [#17](https://github.com/opengeos/HyperCoast/pull/17) +- Add pace module by @giswqs in [#19](https://github.com/opengeos/HyperCoast/pull/19) + +**Full Changelog**: [v0.1.2...v0.1.3](https://github.com/opengeos/HyperCoast/compare/v0.1.2...v0.1.3) + +## v0.1.2 - Apr 25, 2024 + +**What's Changed** + +- Add demo gif by @bingqing-liu in [#15](https://github.com/opengeos/HyperCoast/pull/15) +- Fix typos and add method bug by @giswqs in [#16](https://github.com/opengeos/HyperCoast/pull/16) + +**Full Changelog**: [v0.1.1...v0.1.2](https://github.com/opengeos/HyperCoast/compare/v0.1.1...v0.1.2) + +## v0.1.1 - Apr 22, 2024 + +**What's Changed** + +- Add an EMIT notebook by @giswqs in [#13](https://github.com/opengeos/HyperCoast/pull/13) +- Fix dependency issue by @giswqs in [#14](https://github.com/opengeos/HyperCoast/pull/14) + +**Full Changelog**: [v0.1.0...v0.1.1](https://github.com/opengeos/HyperCoast/compare/v0.1.0...v0.1.1) + +## v0.1.0 - Apr 21, 2024 + +**What's Changed** + +- Improve support for visualizing EMIT data by @giswqs in [#10](https://github.com/opengeos/HyperCoast/pull/10) +- Add ui module by @giswqs in [#11](https://github.com/opengeos/HyperCoast/pull/11) +- Add support for displaying spectral signature interactively by @giswqs in [#12](https://github.com/opengeos/HyperCoast/pull/12) + +**Full Changelog**: [v0.0.3...v0.1.0](https://github.com/opengeos/HyperCoast/compare/v0.0.3...v0.1.0) + +## v0.0.3 - Apr 20, 2024 + +**What's Changed** + +- Fix typos by @giswqs in [#7](https://github.com/opengeos/HyperCoast/pull/7) +- Add conda-forge installation instructions by @giswqs in [#8](https://github.com/opengeos/HyperCoast/pull/8) +- Add support for visualizing EMIT data by @giswqs in [#9](https://github.com/opengeos/HyperCoast/pull/9) + +**Full Changelog**: [v0.0.2...v0.0.3](https://github.com/opengeos/HyperCoast/compare/v0.0.2...v0.0.3) + +## v0.0.2 - Apr 18, 2024 + +**What's Changed** + +- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in [#4](https://github.com/opengeos/HyperCoast/pull/4) +- Update readme by @Bingqing9027 in [#5](https://github.com/opengeos/HyperCoast/pull/5) +- Add Map class by @giswqs in [#6](https://github.com/opengeos/HyperCoast/pull/6) + +**New Contributors** + +- @pre-commit-ci made their first contribution in [#4](https://github.com/opengeos/HyperCoast/pull/4) +- @Bingqing9027 made their first contribution in [#5](https://github.com/opengeos/HyperCoast/pull/5) +- @giswqs made their first contribution in [#6](https://github.com/opengeos/HyperCoast/pull/6) + +**Full Changelog**: [v0.0.1...v0.0.2](https://github.com/opengeos/HyperCoast/compare/v0.0.1...v0.0.2) + +## v0.0.1 - Apr 8, 2024 + +**What's Changed** +**Full Changelog**: [v0.0.1](https://github.com/giswqs/HyperCoast/commits/v0.0.1) diff --git a/docs/changelog_update.py b/docs/changelog_update.py new file mode 100644 index 0000000..55145bb --- /dev/null +++ b/docs/changelog_update.py @@ -0,0 +1,43 @@ +import re + +# Copy the release notes from the GitHub release page +markdown_text = """ +## What's Changed +* Update pace_chla_to_image_function by @giswqs in https://github.com/opengeos/HyperCoast/pull/69 + + +**Full Changelog**: https://github.com/opengeos/HyperCoast/compare/v0.6.2...v0.6.3 +""" + +# Regular expression pattern to match the Markdown hyperlinks +pattern = r"https://github\.com/opengeos/HyperCoast/pull/(\d+)" + + +# Function to replace matched URLs with the desired format +def replace_url(match): + pr_number = match.group(1) + return f"[#{pr_number}](https://github.com/opengeos/HyperCoast/pull/{pr_number})" + + +# Use re.sub to replace URLs with the desired format +formatted_text = re.sub(pattern, replace_url, markdown_text) + +for line in formatted_text.splitlines(): + if "Full Changelog" in line: + prefix = line.split(": ")[0] + link = line.split(": ")[1] + version = line.split("/")[-1] + formatted_text = ( + formatted_text.replace(line, f"{prefix}: [{version}]({link})") + .replace("## What's Changed", "**What's Changed**") + .replace("## New Contributors", "**New Contributors**") + ) + + +with open("docs/changelog_update.md", "w") as f: + f.write(formatted_text) + +# Print the formatted text +print(formatted_text) + +# Copy the formatted text and paste it to the CHANGELOG.md file