From 4d87493ef0df3f1cfb02c5fb6b8318983a541481 Mon Sep 17 00:00:00 2001
From: Albert Mitjans I Coma <amitjans@ethz.ch>
Date: Mon, 6 Sep 2021 13:10:24 +0000
Subject: [PATCH] Update README.md

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 2db8f62..bb9adb6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
 # Ion trap image analysis  
 
 This project is focused on extracting information from images of an ion trap.
+
+
+- app.py: Starts image analysis in a background thread and creates a web app at port 5000.
+
+- calibrate.py: Run this script to calibrate the distance factor used for dark ions detection. Run preferably when there are no dark ions present.
+
+
+To change the region of interest where the image analysis takes place, either:
+
+- Edit the top-left and bottom-right coordinates of the region of interest manually under settings.py --> REGION
+
+- Run: python -c "from tools import new_region; new_region()". This will open a matplotlib figure with an image of the trapped-ions. The user should click on the top-left and bottom-right coordinates.
-- 
GitLab