Skip to content

Commit d6ca59b

Browse files
Add installation instructions
1 parent 4b11d8e commit d6ca59b

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,34 @@ it.
3232
Developed and provided by the [Imaging Core Facility (IMCF)][imcf] of the
3333
Biozentrum, University of Basel, Switzerland.
3434

35+
## Installation Instructions
36+
37+
### Required Update Sites
38+
39+
After a fresh install of [Fiji](https://fiji.sc/), navigate to *Help* -> *Update* and in the resulting window, press *Manage Update Sites*. Here, search for and tick the following necessary update sites for this package.
40+
41+
- ImageJ
42+
- Fiji
43+
- 3D ImageJ-Suite
44+
- clij2
45+
- IJPB-plugins
46+
- IMCF Uni Basel
47+
- StarDist
48+
- CALM
49+
- TrackMate-Cellpose
50+
- TrackMate-Helper
51+
- TrackMate-StarDist
52+
- TrackMate-Weka
53+
- TrackMate-MorpholibJ
54+
55+
The **`IMCF Uni Basel`** update-site will supply the necessary `.jar` to run the functions contained in this package, but alternatively, the most up-to-date `.jar` for this package can be always found on the [Scijava Maven repository][scijava-1.5.0], which links to, for example, the `1.5.0` version of `python-imcflibs`.
56+
57+
If you manually download the `.jar` from Scijava, extract the zip folder, and place the `.jar` file in the `\jars` folder of your Fiji installation, e.g `C:\Tools\Fiji.app\jars\`.
58+
59+
### Testing Installation
60+
61+
To check the package's correct installation in Fiji, search for *Script Interpreter* in the Search bar, and type `:lang python`, followed by e.g. `import imcflibs.imagej.misc`. If no errors are shown, the installation was successful. Alternatively, you can scroll in the sidebar of the Interpreter to search for imcflibs.
62+
3563
## Example usage
3664

3765
### Shading correction / projection
@@ -69,3 +97,4 @@ correct_and_project(raw_image, out_path, model, "Maximum", ".ics")
6997
[apidocs]: https://imcf.one/apidocs/imcflibs/imcflibs.html
7098
[pdoc]: https://pdoc.dev/
7199
[pypi]: https://pypi.org/project/imcflibs/
100+
[scijava-1.5.0]: https://maven.scijava.org/#browse/browse:releases:ch%2Funibas%2Fbiozentrum%2Fimcf%2Fpython-imcflibs%2F1.5.0%2Fpython-imcflibs-1.5.0.jar

0 commit comments

Comments
 (0)