From 4310741d4a16423b27e8dc41219720f41ba30506 Mon Sep 17 00:00:00 2001 From: Arman Date: Wed, 19 Apr 2023 19:02:48 -0400 Subject: [PATCH 1/6] Added badges and centered the title --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 693076d..40f06a9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ +
+ # Neuroimaging Results Visualization +
+ + + + + Python + + + GitHub license + +
+
+
+ Neuroimaging Results Visualization (NeRV) is an interface developed in Python using Plotly Dash and pandas for visualization of neuroimaging results obtained from continuous testing of neuroimaging data across software pipelines. ## Getting Started From ead8dfad5f0eb7254dcfcb59704d764195931dcb Mon Sep 17 00:00:00 2001 From: Arman Date: Wed, 19 Apr 2023 19:04:02 -0400 Subject: [PATCH 2/6] Updated embedded image of app ui --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 40f06a9..28cd911 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ app.start("path-to-data-directory") Once the file containing the above snipet is executed, a local server (at port 8050 by default) is launched. The server and the app can be accessed by browser through `localhost:8050` url. -

+

## Deployment From f53f9123874ffdbe6eed846893f0ecac9224b21b Mon Sep 17 00:00:00 2001 From: Arman Date: Wed, 19 Apr 2023 19:10:05 -0400 Subject: [PATCH 3/6] Updated the `license` section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 28cd911..1163ae0 100644 --- a/README.md +++ b/README.md @@ -46,4 +46,4 @@ _Work in progress_ ## License -This package is licensed under the [MIT License](LICENSE). +This project is licensed under the terms of [MIT License](LICENSE). From d601aa2c43bce090e8eef304fe55ffcbaac5ddc9 Mon Sep 17 00:00:00 2001 From: Arman Date: Wed, 19 Apr 2023 19:24:52 -0400 Subject: [PATCH 4/6] Updated the `Getting Started` section --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1163ae0..57e4c34 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,9 @@ Neuroimaging Results Visualization (NeRV) is an interface developed in Python us ## Getting Started -### Install the package using pip +### Installation -```cmd +```bash pip install nerv ``` @@ -36,7 +36,7 @@ from nerv import app app.start("path-to-data-directory") ``` -Once the file containing the above snipet is executed, a local server (at port 8050 by default) is launched. The server and the app can be accessed by browser through `localhost:8050` url. +After executing the file containing the above code snippet, a local server is started at port 8050 (by default). You can access the running NeRV application using a browser through the URL `localhost:8050`.

From c91c5946c584a8af5ffdfb0b44dd6375c4932f7f Mon Sep 17 00:00:00 2001 From: Arman Date: Wed, 19 Apr 2023 19:25:46 -0400 Subject: [PATCH 5/6] Updated project description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 57e4c34..fd281d9 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@
-Neuroimaging Results Visualization (NeRV) is an interface developed in Python using Plotly Dash and pandas for visualization of neuroimaging results obtained from continuous testing of neuroimaging data across software pipelines. +Neuroimaging Results Visualization (NeRV) is a web interface developed in Python using [Plotly Dash](https://dash.plotly.com/), [Dash Bootstrap Components](https://dash-bootstrap-components.opensource.faculty.ai/), and [pandas](https://pandas.pydata.org/) for visualization of neuroimaging results obtained from continuous testing of neuroimaging data across software pipelines. ## Getting Started From 5d4e19de84691befb417ebf5f52d71275d6eabc2 Mon Sep 17 00:00:00 2001 From: Arman Date: Wed, 19 Apr 2023 19:29:28 -0400 Subject: [PATCH 6/6] Updated layout Added horizontal lines between sections --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index fd281d9..7404c2e 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ Neuroimaging Results Visualization (NeRV) is a web interface developed in Python using [Plotly Dash](https://dash.plotly.com/), [Dash Bootstrap Components](https://dash-bootstrap-components.opensource.faculty.ai/), and [pandas](https://pandas.pydata.org/) for visualization of neuroimaging results obtained from continuous testing of neuroimaging data across software pipelines. +______________________________________________________________________ + ## Getting Started ### Installation @@ -40,10 +42,14 @@ After executing the file containing the above code snippet, a local server is st

+______________________________________________________________________ + ## Deployment _Work in progress_ +______________________________________________________________________ + ## License This project is licensed under the terms of [MIT License](LICENSE).