Merge branch 'main' into issue/228

.github/ISSUE_TEMPLATE/workflow_contribution.md

@@ -0,0 +1,30 @@
+
+Thanks for contributing a workflow to CoastSeg! Please read and follow these instructions carefully, then delete this introductory text to keep your issue easy to read. Feel free to keep the titles described here to ensure our team can easily understand your issue. Note that the issue tracker is NOT the place for usage questions and technical assistance.
+
+A guide on how to submit a workflow can be found in the wiki :[Contribution Guide]( https://github.com/Doodleverse/CoastSeg/wiki/13.-%5BADVANCED%5D-Contribution-Guide/_edit#contributing-workflows:~:text=Contributing%20Workflows)
+## Describe the New Workflow
+A clear and concise description of what the bug is.
+
+## Notebook & Code
+1. Enter the name of your notebook here
+- Example: `SDS_new_workflow_name.ipynb` in CoastSeg 
+2. Enter the name of were the python file containing the code for your workflow to run.
+- If all the code for your workflow is in the notebook, then state that here.
+- Example: Create `new_workflow_name.py` which contains all the code for your workflow
+
+## Steps To Run this Workflow
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Screenshots
+If applicable, add screenshots to show what your worklow
+
+
+
+### **Additional context**
+Add any other context about the your workflow.

README.md

@@ -56,7 +56,8 @@ In more detail, CoastSeg represents the following advances in satellite-derived
 
 Version 1 is now stable, and we have a lot of planned new features for version 2.
 
-![gif of map with rectangles on it](https://github.com/SatelliteShorelines/CoastSeg/blob/main/docs/gifs/create_rois_demo.gif)
+![coastseg_main_flow_updated](https://github.com/Doodleverse/CoastSeg/assets/61564689/ac9076bd-bf40-44c5-a686-0fdc1acf8656)
+
 
 - Create ROIs(regions of interest) along the coast and automatically load shorelines on the map.
 - Use Google Earth Engine to automatically download satellite imagery for each ROI clicked on the map.
@@ -83,9 +84,27 @@ We recommend that you use Windows 10, Windows 11, or Ubuntu Linux. Mac users, pl
 In order to use Coastseg you need to install Python packages in an environment. We recommend you use [Anaconda](https://www.anaconda.com/products/distribution) or [Miniconda](https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html) to install the python packages in an environment for Coastseg. 
 
 After you install miniconda/Anaconda on your PC, open the Anaconda prompt or Terminal in Mac and Linux and use the `cd` command (change directory) to go the folder where you have downloaded the Coastseg repository.
+## Install from conda-forge
+1. Create an miniconda/Anaconda environment and Activate it
+- This command creates an anaconda environment named `coastseg` and installs `python 3.10` in it.
+  ```bash
+  conda create --name coastseg python=3.10 -y
+  conda activate coastseg
+  ```
 
-1. Create an miniconda/Anaconda environment
+2. Install coastseg 
 
+   ```bash
+   conda install coastseg -c conda-forge
+   ```
+3. (Optional) Install Optional Dependencies
+    - Only install these dependencies if you plan to use CoastSeg's zoo workflow notebook. 
+    ```bash
+   pip install tensorflow
+   ```  
+
+## Install from Pypi
+1. Create an miniconda/Anaconda environment
 - This command creates an anaconda environment named `coastseg` and installs `python 3.10` in it.
   ```bash
   conda create --name coastseg python=3.10 -y