Skip to content

Commit

Permalink
Merge pull request #95 from imagej/restructure
Browse files Browse the repository at this point in the history
Re-organize project to improve readability, documentation
  • Loading branch information
gselzer authored Sep 6, 2022
2 parents 9feb839 + 7fb33ed commit 99a115c
Show file tree
Hide file tree
Showing 45 changed files with 2,590 additions and 2,175 deletions.
22 changes: 17 additions & 5 deletions src/napari_imagej/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
__version__ = "0.0.1.dev0"
"""
napari-imagej brings the power of ImageJ, ImageJ2, and Fiji to the napari viewer.
from scyjava import when_jvm_starts
With napari-imagej, users can call headless functionality from any of these applications
on napari data structures. Users can also call SciJava scripts on data in napari,
automatically discoverable within the plugin. Users can launch the ImageJ or ImageJ2
user interfaces from napari-imagej and can explicitly transfer data to and from the
napari user interface. Most importantly, all of this functionality is accessible WITHOUT
any explicit conversion between the two ecosystems!
from napari_imagej._napari_converters import init_napari_converters
napari-imagej is NOT designed to be used on its own; instead, it should be launched
from within the napari application. Please see (https://napari.org/stable/#installation)
to get started using the napari application. Once napari is installed, you can then
add napari-imagej as a plugin. Please see (https://www.napari-hub.org/) for a list
of available plugins, including napari-imagej.
# Install napari <-> java converters
when_jvm_starts(init_napari_converters)
napari-imagej is built upon the PyImageJ project:
https://pyimagej.readthedocs.io/en/latest/
"""
__version__ = "0.0.1.dev0"
Loading

0 comments on commit 99a115c

Please sign in to comment.