Skip to content

Commit b89e7fb

Browse files
committed
Update Installation doc for using Jaunch
1 parent a06281b commit b89e7fb

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

docs/ops/doc/Installation.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,41 @@ One easy way to use SciJava Ops is within [Fiji](https://fiji.sc), using SciJava
88

99
You can install SciJava Ops into Fiji by enabling the SciJava Ops update site, as described in the [Update site tutorial](https://imagej.net/update-sites/following#add-update-sites).
1010

11-
1. With Fiji open, navigate to `Help → Update...`
11+
1. With Fiji open, navigate to `Help Update...`
1212
2. Click `Manage Update Sites`
1313
3. In the `Search` bar at the top of the popup, search `SciJava Ops`
1414
4. Find the `SciJava Ops` row, and check the checkbox in the `Active` column.
1515
5. Click `Apply and Close`. You should see many items appear in the `ImageJ Updater` table.
1616
6. Click `Apply Changes`
17-
7. Restart Fiji
17+
7. **Note: launcher change** Close and restart Fiji using the new launcher: `fiji-[platform]`. For example, if you were on 64-bit Windows your old (deprecated) launcher was `ImageJ-win64.exe`, and you would instead now use `fiji-windows-x64.exe`.
18+
8. Run `Help → Update...` a second time. Historically Fiji has shipped with Java 8, but a newer Java is required for SciJava Ops. You should get a dialog saying a new Java version is recommended, and asking if you'd like to update. Click `OK` to start the update. This download and extraction may take longer than a usual update.
19+
9. After receiving a notification that the Java update is complete you can close Fiji and restart one more time to take advantage of the new Java. **Note:** always use the new `fiji-` launcher going forward.
20+
10. After Fiji restarts, you can [double-check the Java version](https://imagej.net/learn/troubleshooting#checking-the-java-version) - it should be `21` or newer.
21+
22+
At this point you can proceed with using SciJava Ops!
23+
24+
### Troubleshooting
25+
26+
SciJava Ops uses a branch new launcher and updating logic to get access to new Java programming language features. These have not reached the main Fiji release yet and thus have not gone through community hardening yet, so errors may pop up.
27+
28+
If the following steps do not help resolve your situation, please [report the issue](https://imagej.net/discuss/bugs) on the [ImageJ forum](https://forum.image.sc/) or [Zulip](https://imagej.net/discuss/chat#zulip).
29+
30+
#### The new fiji- launcher doesn't start
31+
32+
Double-check the `Fiji.app/config/jaunch` directory [Windows/Linux] or `Fiji.app/Contents/MacOS`. There should be a number of files including `jvm.toml`, `fiji.toml`, `common.toml`. If they aren't there, they may be stuck in the same path under the `Fiji.app/update` directory: you can manually copy them out to the base `Fiji.app` diretory, following the same subdirectory structure they had under `/update/`.
33+
34+
#### I did the new Java update but after restarting Fiji is not using Java 21
35+
36+
The new java should have been downloaded to `Fiji.app/java/[platform/` and will likely have a directory name along the lines of `zulu21[...]jdk21[...]`.
37+
38+
In your `Fiji.app/config/jaunch` directory you should have a file named `fiji.cfg` containing the line:
39+
40+
```
41+
jvm.app-configured=/path/to/downloaded/java
42+
```
43+
44+
Ensure that the right hand side of this assignment matches the Java download location.
45+
46+
#### Other failures
47+
48+
We have tested these steps using [freshly downloaded Fiji installations](https://imagej.net/downloads) for each platform. Given the number of update sites and plugins available for Fiji, it is possible there are unforseen interactions. Thus, falling back to one of these fresh installs is a recommended starting point.

0 commit comments

Comments
 (0)