From 6613f82248fb99ab978996514fbffa6db629a631 Mon Sep 17 00:00:00 2001 From: "Hou, Han" Date: Thu, 4 Apr 2024 10:16:19 -0700 Subject: [PATCH] docs: add CO debugging instructions --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e53b04b..4770f5f 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,29 @@ and this URL will show exactly the plot below. Note the filters and plot setting image -

+
So far, theses are all supported fields in the URL query: https://github.com/AllenNeuralDynamics/foraging-behavior-browser/blob/3f4124e98ed7aa3524b2d32c0670e8cd92ec9e41/code/Home.py#L54-L85 +## Develop in Code Ocean +1. Duplicate the capsule [`foraging-behavior-browser`](https://codeocean.allenneuraldynamics.org/capsule/3373065/tree?cw=true) +2. Start a VS Code machine +3. Click "Start Debugging" or press F5 + + +4. You should see something like this in the terminal + + + + and a dialog like this + + + + Press "Open in Browser" will initiate the app. +5. If "Open in Browser" doesn't show up, click the browser icon in `Ports - 8501 - Local Address`. + + ![image](https://github.com/AllenNeuralDynamics/foraging-behavior-browser/assets/24734299/d7665389-5bf1-469c-947d-54e48ff9fed7) + +6. You can start to debug the app by adding break points etc. +