Skip to content

Commit 8cf0d73

Browse files
committed
update main readme tree
1 parent dacb616 commit 8cf0d73

File tree

1 file changed

+39
-31
lines changed

1 file changed

+39
-31
lines changed

README.md

Lines changed: 39 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ Follow the steps below to set up and run the Flask application locally:
4646
1. **Clone the Repository**
4747

4848
```bash
49-
git clone https://github.com/Dheeraj791/NeuroSense.git
50-
cd your-flask-app
49+
git clone https://github.com/Dheeraj791/NeuroSense.git
50+
cd NeuroSense
5151
```
5252

5353
2. **(Optional) Create and Activate a Virtual Environment**
@@ -111,21 +111,21 @@ Follow the steps below to set up and run the Flask application locally:
111111

112112
## Features
113113

114-
# Single Video Upload
114+
### Single Video Upload
115115
Upload a single ultrasound video along with its muscle group and probe orientation.
116116
This feature is designed to support large ultrasound files (GB-scale).
117117

118118
A small 1-2 MB test sample video is included for functionality testing purposes.
119119

120-
# Bulk Video Upload via Excel
120+
### Bulk Video Upload via Excel
121121
Upload an entire folder of ultrasound videos using select folder functionality, automatically generate an Excel template, fill in details such as muscle group and probe orientation, and submit it for processing.
122122
This enables batch analysis for high-throughput use cases or larger clinical datasets.
123123

124-
# Live Video Previews & Fasciculation Visualization
124+
### Live Video Previews & Fasciculation Visualization
125125
After processing, the application provides live previews of all videos.
126126
Detected fasciculations are overlaid in real time, and an interactive graph shows their distribution across the video timeline for easy verification and interpretation.
127127

128-
# Fullscreen Viewing Mode
128+
### Fullscreen Viewing Mode
129129
All processed videos can be expanded to fullscreen, enhancing clarity during analysis and review of subtle fasciculation patterns.
130130

131131

@@ -149,52 +149,60 @@ Here are some related projects
149149
## Repo structure
150150
151151
```
152-
.DS_Store
153-
.gitignore
154-
CODE_OF_CONDUCT.md
155-
Core
156-
Readme.md
157-
__init__.py
152+
153+
├─ .DS_Store
154+
├─ .github
155+
│  └─ workflows
156+
│     └─ paper.yml
157+
├─ .gitignore
158+
├─ Core
159+
│  ├─ Readme.md
160+
│  ├─ __init__.py
158161
│  ├─ processing.py
159162
│  └─ setup_ffmpeg.py
160-
LICENSE
161-
README.md
163+
├─ LICENSE
164+
├─ README.md
162165
├─ app.py
163-
paper.bib
164-
paper.md
165-
requirements.txt
166-
static
166+
├─ code_of_conduct.md
167+
├─ contributing.md
168+
├─ joss-paper
169+
│  └─ figures
170+
│     └─ hl_architecture.png
171+
├─ paper.bib
172+
├─ paper.md
173+
├─ requirements.txt
174+
├─ static
167175
│  ├─ .DS_Store
168-
css
176+
│  ├─ css
169177
│  │  ├─ alert.css
170-
bulk_results.css
171-
home.css
172-
result.css
178+
│  │  ├─ bulk_results.css
179+
│  │  ├─ home.css
180+
│  │  ├─ result.css
173181
│  │  └─ style.css
174182
│  ├─ images
175183
│  │  ├─ NEuroSense.png
176-
architecture.png
177-
background.jpg
184+
│  │  ├─ architecture.png
185+
│  │  ├─ background.jpg
178186
│  │  └─ image_product.png
179187
│  ├─ js
180188
│  │  ├─ .DS_Store
181-
alert.js
182-
config.js
189+
│  │  ├─ alert.js
190+
│  │  ├─ config.js
183191
│  │  └─ script.js
184192
│  └─ logo
185193
│     ├─ .DS_Store
186194
│     └─ logo.png
187195
├─ templates
188196
│  ├─ bulk_results.html
189-
index.html
197+
│  ├─ index.html
190198
│  └─ result.html
191199
└─ tests
192200
   ├─ .DS_Store
193-
Readme.md
194-
__init__.py
195-
sample_data
201+
   ├─ Readme.md
202+
   ├─ __init__.py
203+
   ├─ sample_data
196204
   │  ├─ README.md
197-
test_data_template.xlsx
205+
   │  ├─ test_data_template.xlsx
198206
   │  └─ test_video.mp4
199207
   ├─ test_ui.py
200208
   └─ test_util.py

0 commit comments

Comments
 (0)