Skip to content

Commit

Permalink
Update readme, fixes for workflow docs
Browse files Browse the repository at this point in the history
  • Loading branch information
multimeric committed Aug 23, 2024
1 parent 0af6fc2 commit 05ba85c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 18 deletions.
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![PyPI - Downloads](https://img.shields.io/pypi/dm/napari-lattice)](https://pypistats.org/packages/napari-lattice)
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-lattice)](https://napari-hub.org/plugins/napari-lattice)

This napari plugin allows deskewing, cropping, visualisation and designing custom analysis pipelines for lattice lightsheet data, particularly from the Zeiss Lattice Lightsheet. The plugin has also been otpimixed to run in headless mode.
This napari plugin allows deskewing, cropping, visualisation and designing custom analysis pipelines for lattice lightsheet data, particularly from the Zeiss Lattice Lightsheet. The plugin has also been optimized to run in headless mode.


## **Documentation**
Expand All @@ -17,10 +17,7 @@ Check the [Wiki page](https://github.com/BioimageAnalysisCoreWEHI/napari_lattice

*************


<p align="left">
<img src="https://raw.githubusercontent.com/BioimageAnalysisCoreWEHI/napari_lattice/master/resources/LLSZ_window.png" alt="LLSZ_overview" width="500" >
</p>
![](deskew.png)

**Functions**

Expand All @@ -44,25 +41,15 @@ Apply custom image processing workflows using `napari-workflows`.

Support will be added for more file formats in the future.

Sample lattice lightsheet data download: https://doi.org/10.5281/zenodo.7117784
Sample lattice lightsheet data download: <https://doi.org/10.5281/zenodo.7117784>

----------------------------------

This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.

<!--
Don't miss the full getting started guide to set up your new package:
https://github.com/napari/cookiecutter-napari-plugin#getting-started
and review the napari docs for plugin developers:
https://napari.org/plugins/index.html
-->


## Contributing

Contributions are very welcome. Tests can be run with [tox], please ensure
the coverage at least stays the same before you submit a pull request.
Contributions are very welcome. Please refer to the [Development](./development) docs to get started.

## License

Expand Down
2 changes: 1 addition & 1 deletion docs/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The advantage of this is that you can design a multi-step automated workflow tha

## Building a Workflow

You can design your workflow via GUI using [`napari-assistant](https://github.com/haesleinhuepf/napari-assistant), or in the YAML format.
You can design your workflow via GUI using [`napari-assistant`](https://github.com/haesleinhuepf/napari-assistant), or directly in the YAML format.

When building your workflow with Napari Assistant, you are actually building a *template* that will be applied to future images.
For this reason, you need to rename your input layer to `deskewed_image`, since this is the exact value that the `lls_core` step produces.
Expand Down

0 comments on commit 05ba85c

Please sign in to comment.