Skip to content

Releases: SatelliteShorelines/CoastSeg

Release v1.0.0

08 Sep 22:12
Compare
Choose a tag to compare

Release v1.0.0

Release Date: September 8, 2023
We are excited to announce the first official release of CoastSeg, called v1.0.0. This release is a stable version of the program that incorporates the following features:

  1. An emulation of the CoastSat methodology for defining a shoreline extraction project, image downloading, shoreline extraction, shoreline filtering, and tide correction, all within a single jupyter notebook that can be accessed online
  2. A pip-installable package for CoastSat workflows
  3. Use of concurrency for image downloads from Google Earth Engine
  4. A faster and more convenient API-based methodology for tidal height estimation, using pyTMD
  5. An initial implementation of an alternative shoreline mapping workflow using Zoo models from the Doodleverse
  6. A conda environment that can work on secure networks
  7. Script-based data wrangling utilities
  8. Hyperparameter experimentation and tracking using an organizational workflow idea called ‘Sessions’
  9. Supporting databases for transects, reference shorelines, beach slopes, and other useful metadata variables
    We highly recommend all users to upgrade. The next major release is planned for December/January. See the roadmap for further details

Support

The development of this provisional software has been sponsored and supported by the U.S. Geological Survey Pacific Coastal and Marine Science Center, through the Remote Sensing Coastal Change project. The purpose of the software is to map U.S. coastal shoreline locations from a time-series of satellite imagery. CoastSeg may also be valuable to the global research community.
This software is preliminary or provisional and is subject to revision. It is being provided to meet the need for timely best science. The software has not received final approval by the U.S. Geological Survey (USGS). No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. The software is provided on the condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the software.

How to Upgrade

To upgrade to the latest version, you can follow these steps:

  1. Pull the latest version from the main branch. git pull origin main
  2. pip install coastseg==v1.0.0
    Please refer to the project's readme file for more information about installing and configuring.

Recent Features (implemented in August/September 2023)

  • Cloud Masking On/Off Switch: Cloud Masking now now be turned on or off for extracting shorelines and downloading imagery #188
  • Preview Images Available: Added a preview button to view the number of images available for each ROI #169
  • Automatic Tide Correction Button Each ROI can be tidally corrected using the correct tides button. #172
  • Download Tide Model Notebook Created a notebook to download and clip the FES2014 tide model. Download_tide_model.ipynb is an alternative workflow to the workflow described in the wiki Download-Tide-Model-Guide. See #190

Recent Bug Fixes (implemented in August/September 2023)

  • Fixed issue where cloud mask issue would never be set to True
  • Features render on all parts of the infinite world map #174

Recent Improvements (implemented in August/September 2023)

  • Shorelines render as points instead of lines #187
  • Renamed SDS_unet_classifier.ipynb to SDS_zoo_classifier.ipynb #177

Recent Changelog

Developer contributions (CRediT; Contributor Roles Taxonomy)

@sharon2320: Software Development, Packaging, Software Release, Automation, Methodology, Validation, Writing - Original Draft
@dbuscombe-usgs: Conceptualization, Methodology, Supervision, Project administration, Funding acquisition, Data Curation, Modeling, Resources, Investigation, Formal analysis, Validation, minor software contributions, Writing - Review & Editing

Additional contributions

We would like to thank all our contributors who contributed ideas to this release:

  • @venuswku
  • @robbibt
  • @kvos
  • @edlazarus
  • Beta testers: Catherine Janda, Ann Gibbs, Jon Warrick, Andrea O’Neill, Kathryn Weber, Julia Heslin (USGS)
    We would like to express our gratitude to all the contributors who made this release possible. Thank you to everyone who tested the beta versions of coastseg and provided us with the feedback we needed to improve coastseg. Thanks also to the developers and maintainers of pyTMD, DEA-tools, xarray, and GDAL, without which this project would be impossible
    For a complete list of code contributors, see the GitHub contributors page.

Feedback

We are eager to hear about your experiences with this new release. Please provide your feedback, file issues, or contribute a pull request on our GitHub page.

CoastSeg Release 0.0.74

22 Aug 21:54
Compare
Choose a tag to compare

CoastSeg Release 0.0.74

We are excited to announce the release of CoastSeg v0.0.74. We would like to express our gratitude to all the contributors who made this release possible. This version introduces a lot of enhancements and new features, and we highly recommend all users to upgrade.

pip install coastseg==0.0.74

New Features

  1. Coastseg has a preview button which lets you view the number of available images for each satellite.
  2. Users can now click and delete reference shorelines
  3. world_copy_jump=True fixes the issue where geometries weren't loading on the infinite map
  4. User can now click and delete selected ROIs

Issues Closed

  1. 177
  2. 174
  3. 169
  4. 186

CoastSeg Release 0.0.73

04 Aug 17:55
Compare
Choose a tag to compare

CoastSeg Release 0.0.73

We are excited to announce the release of CoastSeg v0.0.73. We would like to express our gratitude to all the contributors who made this release possible. This version introduces a lot of enhancements and new features, and we highly recommend all users to upgrade.

pip install coastseg==0.0.73

New Features

  1. Coastseg will automatically detect if downloads are occurring on a secure network and attempt to use the ssl certificate file in the location within the certifications.json file.
  2. The Error Message when the ssl file is missing now tells the user to enter the location of ssl certificate file in the certifications.json file

CoastSeg Release 0.0.72

03 Aug 16:29
Compare
Choose a tag to compare

CoastSeg Release 0.0.72

We are excited to announce the release of CoastSeg v0.0.72. We would like to express our gratitude to all the contributors who made this release possible. This version introduces a lot of enhancements and new features, and we highly recommend all users to upgrade.

pip install coastseg==0.0.72

New Features

  1. Users can now delete selected ROIs #166
  2. Users can delete selected shorelines
    how_to_delete_parts_shoreline
  3. Added an on/off switch for the cloud mask issue
  4. New MNDWI and NDWI segformer models have been added
  5. The resunet NDWI,MNDWI, and 5 band models have been removed from coastseg

Improvements

  1. Filter_metadata function has been fixed so now extracted shorelines in the time series csv display the correct dates.
  2. A warning message now appears when the user loads a session where downloaded imagery is missing instead of error message.
  3. Extract Shorelines wiki has been updated with steps for how to extract shorelines

Changes

  1. shoreline_buffer min value is 5 when before it was 50 to allow more fine tune control
  2. beach area slider min: 100m before it was 1000m

Issues Closed

Issues in Progress

  • #124
  • Working on a tidal correction script
  • Updating Guides for extracting shorelines with CoastSat
  • Fixing a bug with reference shoreline buffers discovered with unet shoreline extraction

CoastSeg PreRelease Version 0.0.72dev7

01 Aug 23:19
Compare
Choose a tag to compare
Pre-release

CoastSeg Pre-Release 0.0.72dev7

New Features

  1. Users can now delete selected ROIs #166
  2. Users can delete selected shorelines
  3. Added an on/off switch for the cloud mask issue

Changes

  1. shoreline_buffer min value is 5 when before it was 50 to allow more fine tune control
  2. beach area slider min: 100m before it was 1000m

Issues Closed

Issues in Progress

  • #124
  • Working on a tidal correction script
  • Updating Guides for extracting shorelines with CoastSat
  • Updating Guides for filtering images
  • Fixing a bug with reference shoreline buffers discovered with unet shoreline extraction

CoastSeg Release Version 0.071

03 Jul 17:51
Compare
Choose a tag to compare

Release v0.0.71

Release Date: July 3, 2023

We are excited to announce the release of CoastSeg v0.0.71 which has a bug fix for issue #156.

Users on secure networks can now use coastseg to securely download files.
Users on a secure network need to modify the certifications.json file in the main coastseg directory to include the path to your cert file.
certifications.json example screenshot

Changelog

Bug Fixes

  • Fixed issue #156 Users on secure networks can now use coastseg to securely download files by adding the path to their cert file to the certifications.json file

Improvements

New Features

Contributors

We would like to thank all our contributors who worked on this release:

For a complete list of code contributors, see the GitHub contributors page.

How to Upgrade

To upgrade to the latest version, you can follow these steps:

  1. Pull the latest version from the main branch. git pull origin main
  2. pip install v0.0.71

Please refer to the project's readme file for more information about installing and configuring.

Feedback

We are eager to hear about your experiences with this new release. Please provide your feedback, file issues, or contribute a pull request on our GitHub page.

CoastSeg Release Version 0.0.70

08 Jun 22:34
Compare
Choose a tag to compare

Release v0.070

Release Date: June 12, 2023

We are excited to announce the release of CoastSeg v0.0.70

Changelog

Bug Fixes

  • Fixed issue #119 extract shorelines no longer crashes when computing shoreline transect intersections

Improvements

  • Improved extract shorelines performance (no longer crashes)
  • Progress bars reflect progress for extracting shorelines better
  • More tests for better stability (75 and counting!)
  • Users can upload transect geojson files with any CRS

New Features

  • Feature 1: Users can now filter out bad RGB imagery and wiki guide for how to use it (issue #137)
  • Feature 2: New transects have been added for the United States and older transects were removed (issue #139)

Contributors

We would like to thank all our contributors who worked on this release:

For a complete list of code contributors, see the GitHub contributors page.

How to Upgrade

To upgrade to the latest version, you can follow these steps:

  1. Pull the latest version from the main branch. git pull origin main
  2. pip install v0.0.70

Please refer to the project's readme file for more information about installing and configuring.

Feedback

We are eager to hear about your experiences with this new release. Please provide your feedback, file issues, or contribute a pull request on our GitHub page.

v0.068dev6

12 Jun 21:04
Compare
Choose a tag to compare
v0.068dev6 Pre-release
Pre-release

Release v0.068dev6

Release Date: June 8, 2023

We are excited to announce the release of CoastSeg v0.068dev6.

Changelog

Bug Fixes

  • Fixed issue #145 removed 2 class models

Improvements

  • Improved extract shorelines for unet performance (no longer crashes)
  • Progress bars reflect progress for extracting shorelines better
  • More tests for better stability (75 and counting!)
  • Users can upload transect geojson files with any CRS

New Features

  • Feature 1: Users can now filter out bad RGB imagery and wiki guide for how to use it (issue #137)
  • Feature 2: New transects have been added for the United States and older transects were removed (issue #139)

Contributors

We would like to thank all our contributors who worked on this release:

For a complete list of code contributors, see the GitHub contributors page.

How to Upgrade

To upgrade to the latest version, you can follow these steps:

  1. Pull the latest version from the main branch. git pull origin main
  2. pip install v0.068dev6

Please refer to the project's readme file for more information about installing and configuring.

Feedback

We are eager to hear about your experiences with this new release. Please provide your feedback, file issues, or contribute a pull request on our GitHub page.