andreped commited on
Commit
f2e5326
·
1 Parent(s): 3850c45

Refactored README

Browse files
Files changed (1) hide show
  1. README.md +35 -3
README.md CHANGED
@@ -10,15 +10,32 @@ license: mit
10
  app_file: app.py
11
  ---
12
 
13
- # neukit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
 
15
  ## Demo <a target="_blank" href="https://huggingface.co/spaces/andreped/neukit"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>
16
 
 
 
17
  ![Screenshot 2023-06-05 at 17 31 48](https://github.com/andreped/neukit/assets/29090665/f184fda5-b9db-48fb-b096-dd589e8fce81)
18
 
19
- ## Setup
20
 
21
- For development of this software, follow these steps to build the docker image and run the app through it:
22
 
23
  ```
24
  docker build -t neukit .
@@ -26,3 +43,18 @@ docker run -it -p 7860:7860 neukit
26
  ```
27
 
28
  Then open `http://127.0.0.1:7860` in your favourite internet browser to view the demo.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  app_file: app.py
11
  ---
12
 
13
+ <div align="center">
14
+ <h1 align="center">neukit</h1>
15
+ <h3 align="center">Automatic brain extraction and preoperative tumor segmentation from MRI</h3>
16
+
17
+ [![license](https://img.shields.io/github/license/DAVFoundation/captain-n3m0.svg?style=flat-square)](https://github.com/DAVFoundation/captain-n3m0/blob/master/LICENSE)
18
+ <a target="_blank" href="https://huggingface.co/spaces/andreped/neukit"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>
19
+
20
+ **neukit** was developed by SINTEF Medical Image Analysis to accelerate medical AI research.
21
+
22
+ </div>
23
+
24
+ ## Intro
25
+
26
+ This web application enables users to test [Raidionics](https://raidionics.github.io/), which is an open-source, free-to-use desktop application for pre- and postoperative central nervous system tumor segmentation and standardized reporting. The app only supports single volume input and only demonstrates the segmentation results of the Raidionics software, and thus is only meant for demonstration purposes.
27
+
28
+ For postoperative tumor segmentation, standardized reporting, and better functionality for performing analysis on full cohorts (batch mode), please, refer to the Raidionics software which is hosted [here](https://github.com/raidionics/Raidionics).
29
 
30
  ## Demo <a target="_blank" href="https://huggingface.co/spaces/andreped/neukit"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>
31
 
32
+ To access the live demo, click on the `Hugging Face` badge above. Below is a snapshot of the current state of the demo app.
33
+
34
  ![Screenshot 2023-06-05 at 17 31 48](https://github.com/andreped/neukit/assets/29090665/f184fda5-b9db-48fb-b096-dd589e8fce81)
35
 
36
+ ## Development
37
 
38
+ Alternatively, you can deploy the software locally. Note that this is only relevant for development purposes. Simply dockerize the app and run it:
39
 
40
  ```
41
  docker build -t neukit .
 
43
  ```
44
 
45
  Then open `http://127.0.0.1:7860` in your favourite internet browser to view the demo.
46
+
47
+ ## Citation
48
+
49
+ If you found the tool useful in your research, please, cite the corresponding software paper:
50
+
51
+ ```
52
+ @misc{bouget2023raidionics,
53
+ title={Raidionics: an open software for pre- and postoperative central nervous system tumor segmentation and standardized reporting},
54
+ author={David Bouget and Demah Alsinan and Valeria Gaitan and Ragnhild Holden Helland and André Pedersen and Ole Solheim and Ingerid Reinertsen},
55
+ year={2023},
56
+ eprint={2305.14351},
57
+ archivePrefix={arXiv},
58
+ primaryClass={physics.med-ph}
59
+ }
60
+ ```