We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent e1de837 commit 244ae33Copy full SHA for 244ae33
1 file changed
docs/index.rst
@@ -36,7 +36,24 @@ Running the unit tests requires Nose.
36
37
python setup.py nosetests
38
39
+Initialization and termination
40
+==============================
41
42
+The javabridge package must be used to start the JVM with loci_tools.jar
43
+which is the Bio-Formats library packaged with python-bioformats or with
44
+your own build of Bio-Formats. As a convenience, bioformats.JARS has a list
45
+of the required jar files.
46
+
47
+.. code::
48
49
+ import javabridge
50
+ import bioformats
51
+ javabridge.start_vm(class_path=bioformats.JARS)
52
53
+ # your program goes here
54
55
+ javabridge.kill_vm()
56
57
Reading images
58
==============
59
0 commit comments