Skip to content

Commit 244ae33

Browse files
author
Lee Kamentsky
committed
Added a section describing how to start the javabridge for bioformats
1 parent e1de837 commit 244ae33

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

docs/index.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,24 @@ Running the unit tests requires Nose.
3636

3737
python setup.py nosetests
3838

39+
Initialization and termination
40+
==============================
3941

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+
4057
Reading images
4158
==============
4259

0 commit comments

Comments
 (0)