Updated the README.md

README.md

@@ -24,9 +24,28 @@ Using the [Anaconda distribution](https://www.anaconda.com/products/individual)
 3. Create a new conda environment called "coastsnap" with the required dependencies. This is the same environment as for the Leaman CoastSnap Toolbox, so you may already have it. If you're not sure, run: `conda info --envs` and look for "coastsnap". Otherwise, create the environment by runnning:
 `conda env create -f environment.yml` 
 
-### Add filepaths
+### Demo (optional)
-1. Open up `coastsnap_sites.csv`. Change the path name in cell E2, to the oneDrive CoastSnap directory (contains Images, Tide Data, Database etc.) 
+The following is a demo to make sure all of the code is working and for the user to get a sense of the intended workflow. It'll take approx. 10 mins (assuming everything works). The code will run on a demo CoastSnap directory (`CoastSnap_DEMO`) with 3 sites. 
-NOTE: This file is called by all of the scripts in this repo. DON'T CHANGE THE STRUCTURE OF THE CSV, as it'll cause the registration.jsx scripts to die. Feel free to add more sites (rows) though.
+
+1. Open up `coastsnap_sites.csv`. Change the path name in cell E2, to the
+path of the `CoastSnap_DEMO` directory.
+2. Open the coastsnap directory 
+3. Run `batch_spotteron_download.bat` [30s]
+- This downloads 5 images each for 3 sites and stores them in CoastSnap_DEMO/Images/Site_Name/Processed) 
+4. Run `batch_photoshop_registration.bat` [2 mins]
+- This registers the 15 images in photoshop and stores them in CoastSnap_DEMO/Images/Site_Name/Photoshop
+5. Run `batch_tag_registered.bat` [3 mins]
+- This tags the photoshop registered images and stores them in CoastSnap_DEMO/Images/Site_Name/Registered. Note: Loading .mat tide data in Python takes a while.
+6. Delete any poorly registered/tagged images in CoastSnap_DEMO/Images/Site_Name/Registered
+7. Run `generate_images_snapshot.bat`
+- This generates a snapshot of the CoastSnap images directory at `images_snapshot.csv`
+
+### Update file paths
+To run this code on the shared oneDrive CoastSnap directory:
+1. Delete `coastsnap_sites.csv`
+2. Rename `coastsnap_sites_ALL.csv` to `coastsnap_sites.csv`
+3. Open `coastsnap_sites.csv` and change the path name in cell E2, to the oneDrive CoastSnap directory. 
+NOTE: `coastsnap_sites.csv` is called by all of the scripts in this repo. DON'T CHANGE THE STRUCTURE OF THE CSV, as it'll cause the registration.jsx scripts to die. Feel free to add more sites (rows) though.
 
 ### Updating repo with latest code
 1. Open your terminal and make sure you're in the directory you cloned the coastsnap repo into.

images_snapshot.csv

@@ -1,35 +1,4 @@
 site,# processed,# photoshop,# registered,stability,most recently deleted
-alex,75,74,73,97%,25-08-2021
+blacksmiths,5,5,4,80%,13-12-2021
-birubi,65,64,0,0%,None deleted
+cathieillaroo,5,5,5,100%,None deleted
-blacksmiths,1581,1577,1381,87%,30-04-2022
+manly,5,5,5,100%,None deleted
-broulee,190,191,93,49%,06-06-2021
-buddina,119,114,85,71%,02-05-2022
-burleigh,245,242,0,0%,None deleted
-byron,1255,1329,676,54%,12-11-2019
-cathieillaroo,97,103,66,68%,12-01-2022
-cathielagoon,74,75,73,99%,10-04-2022
-coolum,80,36,22,28%,17-02-2022
-cooya,55,46,0,0%,None deleted
-cowbay,35,34,0,0%,None deleted
-era,56,56,45,80%,31-10-2021
-fourmile,244,247,115,47%,14-04-2021
-frankston,191,189,157,82%,None deleted
-garie,48,48,0,0%,None deleted
-hungry,128,128,92,72%,13-07-2021
-macsnth,73,72,0,0%,None deleted
-macssth,60,59,0,0%,None deleted
-manly,1167,1262,1122,96%,15-02-2022
-moffat,114,131,215,189%,09-03-2022
-newell,23,34,0,0%,None deleted
-nthnarra,2316,2444,1097,47%,31-12-2020
-queenscliff,85,79,0,0%,None deleted
-rainbow,50,50,0,0%,None deleted
-seaford,69,57,0,0%,None deleted
-shortpoint,222,222,0,0%,None deleted
-stockton1,263,261,33,13%,19-02-2020
-stockton2,215,213,62,29%,25-06-2020
-stockton3,258,256,69,27%,09-05-2020
-tomakin,211,211,142,67%,02-09-2021
-tugun,288,289,132,46%,21-07-2020
-wamberal,372,366,0,0%,None deleted
-wonga,46,46,0,0%,None deleted