From fb8225d2cec16d2fb943d6b2009346c4e6317c0d Mon Sep 17 00:00:00 2001
From: Arin Wongprommoon <arin.wongprommoon@ed.ac.uk>
Date: Tue, 16 May 2023 14:08:38 +0100
Subject: [PATCH] docs(aliby): image annotation commands and destination file

WHY IS THIS CHANGE NEEDED?:
- user needs to know these if they use the annotation script

HOW DOES THE CHANGE SOLVE THE PROBLEM?:
- edit docstring in top of file
---
 src/aliby/bin/annotate.py | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/src/aliby/bin/annotate.py b/src/aliby/bin/annotate.py
index 2ab2d59e..0b334a6e 100644
--- a/src/aliby/bin/annotate.py
+++ b/src/aliby/bin/annotate.py
@@ -5,10 +5,18 @@ Currently only works on UNIX-like systems due to using "/" to split addresses.
 Usage example
 
 From python
-$ python  dev_async_annotator.py --image_path path/to/folder/with/h5files --results_path path/to/folder/with/images/zarr --pos position_name --ncells max_n_to_annotate
+$ python annotator.py --image_path path/to/folder/with/h5files --results_path path/to/folder/with/images/zarr --pos position_name --ncells max_n_to_annotate
 
 As executable (installed via poetry)
-$ dev_async_annotator.py --image_path path/to/folder/with/h5files --results_path path/to/folder/with/images/zarr --pos position_name --ncells max_n_to_annotate
+$ annotator.py --image_path path/to/folder/with/h5files --results_path path/to/folder/with/images/zarr --pos position_name --ncells max_n_to_annotate
+
+During annotation:
+- Assign a (binary) label by typing '1' or '2'.
+- Type 'u' to undo.
+- Type 's' to skip.
+- Type 'q' to quit.
+
+File will be saved in: ./YYYY-MM-DD_annotation/annotation.csv, where YYYY-MM-DD is the current date.
 
 """
 import argparse
-- 
GitLab