From 9528f60cbdc6e037e375651cd2d1cbcb7af24894 Mon Sep 17 00:00:00 2001 From: Igor Tatarnikov <61896994+IgorTatarnikov@users.noreply.github.com> Date: Fri, 16 Aug 2024 15:33:09 +0100 Subject: [PATCH] Update readme (#11) * Added Installation instructions and License * Remove from * Added BSD-3 link * Added Acknowledgments section * Added citation section * Update README.md --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 988f498..68cab30 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,48 @@ # brainglobe-stitch +Stitching tiled 3D light-sheet data in napari + +

+ Stitching a mouse brain acquired at a resolution of 4.06 µm/px, 4.06 µm/px, 5 µm/px using 4 tiles +

+ +---------------------------------- + +A [napari] plugin for stitching tiled 3D acquisitions from a [mesoSPIM] light-sheet microscope. +The plugin utilises [BigStitcher] to align the tiles and napari to visualise the stitched data. + +## Installation + +We strongly recommend to use a virtual environment manager (like `conda`). The installation instructions below +will not specify the Qt backend for napari, and you will therefore need to install that separately. Please see the +[`napari` installation instructions](https://napari.org/stable/tutorials/fundamentals/installation.html) for further advice on this. + +To install latest development version: + + pip install git+https://github.com/brainglobe/brainglobe-stitch.git + +This plugin requires Fiji to be installed on your system. You can download Fiji [here](https://imagej.net/Fiji/Downloads). + +The BigStitcher plugin must be installed in Fiji. Please follow the instructions [here](https://imagej.net/plugins/bigstitcher/#download). ## Seeking help or contributing We are always happy to help users of our tools, and welcome any contributions. If you would like to get in contact with us for any reason, please see the [contact page of our website](https://brainglobe.info/contact.html). + +## Citation +If you find this package useful, please make sure to cite the original BigStitcher publication: +> Hörl, D., Rojas Rusak, F., Preusser, F. *et al.* BigStitcher: reconstructing high-resolution image datasets of cleared and expanded samples. Nat Methods 16, 870–874 (2019). https://doi.org/10.1038/s41592-019-0501-0 + + +## License +Distributed under the terms of the [BSD-3] license, +"brainglobe-stitch" is free and open source software + +## Acknowledgements +This [napari] plugin was generated with [Cookiecutter] using napari's [cookiecutter-napari-plugin] template and the [Neuroinformatics Unit's template](https://github.com/neuroinformatics-unit/python-cookiecutter). + +[napari]: https://napari.org +[mesoSPIM]: https://www.mesospim.org/ +[BigStitcher]: https://imagej.net/BigStitcher +[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin +[Cookiecutter]: https://github.com/audreyr/cookiecutter +[BSD-3]: http://opensource.org/licenses/BSD-3-Clause