Skip to content

Commit dcdfa99

Browse files
C-AchardMMathisLab
andauthored
Add demo instructions (#78)
* Add additional env info + demo instructions * Delete submission_env.txt --------- Co-authored-by: Mackenzie Mathis <[email protected]>
1 parent adaafad commit dcdfa99

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,25 @@ To avoid issues when installing on the ARM64 architecture, please follow these s
8585

8686
**Python 3.8 or 3.9 required.**
8787
Requires **[napari]**, **[PyTorch]** and **[MONAI]**.
88+
Compatible with Windows, MacOS and Linux.
89+
Installation should not take more than 30 minutes, depending on your internet connection.
8890

8991
For PyTorch, please see [the PyTorch website for installation instructions].
9092

9193
A CUDA-capable GPU is not needed but very strongly recommended, especially for training.
9294

9395
If you get errors from MONAI regarding missing readers, please see [MONAI's optional dependencies] page for instructions on getting the readers required by your images.
9496

97+
## Quick demo
98+
99+
After installation, you can run the plugin by running:
100+
101+
napari
102+
103+
and launching the plugin from the Plugins menu.
104+
You may use the test volume in the `examples` folder to test the inference and review tools.
105+
This should run in far less than five minutes on a modern computer.
106+
95107
## Issues
96108

97109
**Help us make the code better by reporting issues and adding your feature requests!**

0 commit comments

Comments
 (0)