Skip to content

Update README.md #20

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

Open
aaronson-ke wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 12 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@ This toolbox was written by Dr. Mitchell Harley at the University of New South W

## Getting Started

1. [Download the CoastSnap Starters Toolkit](https://unsw-my.sharepoint.com/:u:/g/personal/z2273773_ad_unsw_edu_au/EdgaW1h8u0NPh0u8lM1opi4Bb8gVSzVGAhtP4-Eg5jeNEQ?e=DIOUCG) and unzip contents to your local directory. This directory will be your BASE_PATH (needed for step 3)
1. Download the [CoastSnap Starters Toolkit](https://unsw-my.sharepoint.com/:u:/g/personal/z2273773_ad_unsw_edu_au/EdgaW1h8u0NPh0u8lM1opi4Bb8gVSzVGAhtP4-Eg5jeNEQ?e=DIOUCG) and unzip contents to your local directory. This directory will be your BASE_PATH (needed for step 3).

2. Download the MATLAB files of this GitHub site to the CoastSnap/Code directory
2. Download the MATLAB files of this GitHub site to the CoastSnap/Code directory.

3. Make sure you have the following Matlab toolkits installed: mapping toolbox, Statistics and ML toolbox, Image processing toolbox and Curve Fitting Toolbox
3. Download the MATLAB files of the GitHub site for the [Shoreline Mapping Toolbox](https://github.com/Coastal-Imaging-Research-Network/Shoreline-Mapping-Toolbox) to the CoastSnap/Code directory.

4. Update the following two files to match your local setup: CSPsetPaths.m and CSPloadPaths.m
4. Make sure you have the following Matlab toolkits installed: mapping toolbox, Statistics and ML toolbox, Image processing toolbox and Curve Fitting Toolbox.

Thats all - you should now be up and running
5. Update the following two files to match your local setup: CSPsetPaths.m and CSPloadPaths.m.

For an indepth tutorial refer to the following video: https://www.youtube.com/watch?v=Al7vq26dlyk
That's all - you should now be up and running.

For an in-depth tutorial refer to the following recording of the [2020 CoastSnap Workshop.](https://www.youtube.com/watch?v=Al7vq26dlyk)

## Demo using manly CoastSnap example

Expand All @@ -28,18 +30,20 @@ Setting up a new CoastSnap station requires two steps:

2. In the **CoastSnapDB.xlsx** (found in the **Database** folder), create a new tab with the *exact* name as your sitename above. It is best to copy an existing tab like **manly** as the structure of this needs to be identical.

3. Update the information contained in your newly created tab while maintaining the structure provided. Ground Control Points (GCPs) can be created and removed by inserting and deleting the necessary rows.

## Inserting relevant station metadata

To be added

## Managing images using the CoastSnap Database

All new images from various the sources (e.g. Instagram, Facebook, Email) are to be saved to the **Raw** folder for each respective station.
All new images from various sources (e.g. CoastSnap app, Instagram, Facebook, Email) are to be saved to the **Raw** folder for each respective station. After entering the **CSPsetPaths** command in the command window, the **CSPraw2processed** command can be run to process the raw images. The processed images will be saved to the **Processed** folder in the format accepted by the GUI.





## CoastSnap GUI

To open the CoastSnap GUI, open one of the MATLAB script files in the **CoastSnap-Toolbox-master** folder and run the commands **CSPsetPaths** and **CSP** in the MATLAB command window.