last push before submit to joss

mapmanager · Jul 17, 2023 · 95997cd · 95997cd
2 parents d55e65b + e961521
commit 95997cd
Show file tree

Hide file tree

Showing 11 changed files with 118 additions and 119 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ A Python package of path-finding algorithms to find the brightest path between p
 
 ## Getting Started
 
-To install and get started with using this `brightest-path-lib`, please visit the [documentation website](https://mapmanager.net/brightest-path-lib/installation/).
+To install and get started with the `brightest-path-lib`, please visit the [documentation website](https://mapmanager.net/brightest-path-lib/installation/).
 
 For more detailed instructions on how to use the `brightest-path-lib`, please see the [API documentation](https://mapmanager.net/brightest-path-lib/api_docs/).
 

diff --git a/docs/about.md b/docs/about.md
@@ -0,0 +1,3 @@
+The brightest-path-tracing Python package was developed by [Vasudha Jha](https://github.com/VasudhaJha) as a Computer Science Masters project in collaboration with [Robert Cudmore](https://github.com/cudmore) in the [Cudmore lab](https://cudmorelab.github.io/) at the University of California at Davis.
+
+Please get in touch if you would like to use any of our tools.
diff --git a/docs/assets/images/a-star.mov b/docs/assets/images/a-star.mov
diff --git a/docs/assets/images/astar-v2.gif b/docs/assets/images/astar-v2.gif
diff --git a/docs/assets/images/nbastar-v2.gif b/docs/assets/images/nbastar-v2.gif
diff --git a/docs/assets/images/tracing-plugin.png b/docs/assets/images/tracing-plugin.png
diff --git a/docs/index.md b/docs/index.md
@@ -9,16 +9,26 @@ The `brightest-path-lib` is a Python library which allows users to efficiently f
   <figcaption>Finding Brightest Path using NBA* Search</figcaption>
 </figure> -->
 
-![Finding Brightest Path using A* Search](./assets/images/astar.gif)
+## Examples
+
+In these examples, a search is performed from the user specified start (green) and stop (red) points. The progress of the search is animated as cyan fill color and the final brightest-path is shown in yellow.
+
 Finding Brightest Path using A* Search
+![Finding Brightest Path using A* Search](./assets/images/astar-v2.gif)
 
-![Finding Brightest Path using NBA* Search](./assets/images/nbastar.gif)
 Finding Brightest Path using NBA* Search
+![Finding Brightest Path using NBA* Search](./assets/images/nbastar-v2.gif)
 
 ## Capabilities
 
+With its efficient implementation and intuitive API, this library is a valuable tool for anyone working with 2D or 3D images who needs to identify the path with the maximum brightness.
+
 - The library provides easy-to-use functions that take the image data and start and end points as input and return the path with the maximum brightness as output.
 - It supports both grayscale and color images and can handle images of arbitrary sizes.
 - The library also provides support for users to know which points in the image are being considered for the brightest path in real-time so that they display them on the original image.
 
-With its efficient implementation and intuitive API, this library is a valuable tool for anyone working with 2D or 3D images who needs to identify the path with the maximum brightness. We are using it for neuronal tracing to identify the path of a neuron or a set of neurons through a stack of images in our Napari Plugin.
+## Napi Plugin
+
+We have also created a [Napari Tracing Plugin](https://github.com/mapmanager/napari-tracing) to provide an intuititive graphical-user-interface that uses the `brightest-path-lib`` package. We are using this to trace neuronal dendrites and axons.
+
+![Napari Tracing Plugin](./assets/images/tracing-plugin.png)
diff --git a/docs/overview.md b/docs/overview.md
@@ -9,16 +9,26 @@ The `brightest-path-lib` is a Python library which allows users to efficiently f
   <figcaption>Finding Brightest Path using NBA* Search</figcaption>
 </figure> -->
 
-![Finding Brightest Path using A* Search](./assets/images/astar.gif)
+## Examples
+
+In these examples, a search is performed from the user specified start (green) and stop (red) points. The progress of the search is animated as cyan fill color and the final brightest-path is shown in yellow.
+
 Finding Brightest Path using A* Search
+![Finding Brightest Path using A* Search](./assets/images/astar-v2.gif)
 
-![Finding Brightest Path using NBA* Search](./assets/images/nbastar.gif)
 Finding Brightest Path using NBA* Search
+![Finding Brightest Path using NBA* Search](./assets/images/nbastar-v2.gif)
 
 ## Capabilities
 
+With its efficient implementation and intuitive API, this library is a valuable tool for anyone working with 2D or 3D images who needs to identify the path with the maximum brightness.
+
 - The library provides easy-to-use functions that take the image data and start and end points as input and return the path with the maximum brightness as output.
 - It supports both grayscale and color images and can handle images of arbitrary sizes.
 - The library also provides support for users to know which points in the image are being considered for the brightest path in real-time so that they display them on the original image.
 
-With its efficient implementation and intuitive API, this library is a valuable tool for anyone working with 2D or 3D images who needs to identify the path with the maximum brightness. We are using it for neuronal tracing to identify the path of a neuron or a set of neurons through a stack of images in our Napari Plugin.
+## Napi Plugin
+
+We have also created a [Napari Tracing Plugin](https://github.com/mapmanager/napari-tracing) to provide an intuititive graphical-user-interface that uses the `brightest-path-lib`` package. We are using this to trace neuronal dendrites and axons.
+
+![Napari Tracing Plugin](./assets/images/tracing-plugin.png)
diff --git a/docs/simple_notebook.ipynb b/docs/simple_notebook.ipynb
diff --git a/docs/threading_notebook.ipynb b/docs/threading_notebook.ipynb
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -37,4 +37,5 @@ nav:
   - Tutorials: 
     - simple_notebook.ipynb
     - threading_notebook.ipynb
+  - About: about.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		The brightest-path-tracing Python package was developed by [Vasudha Jha](https://github.com/VasudhaJha) as a Computer Science Masters project in collaboration with [Robert Cudmore](https://github.com/cudmore) in the [Cudmore lab](https://cudmorelab.github.io/) at the University of California at Davis.

		Please get in touch if you would like to use any of our tools.