glymur/docs/source/introduction.rst
John Evans 7d9a4efdbd Rewrote jp2dump as an entry point console script.
Some printing UT refactoring was done.
2014-09-11 11:29:17 -04:00

31 lines
1.2 KiB
ReStructuredText

----------------------------------------
Glymur: a Python interface for JPEG 2000
----------------------------------------
**Glymur** is an interface to the OpenJPEG library
which allows one to read and write JPEG 2000 files from Python.
Glymur supports both reading and writing of JPEG 2000 images, but writing
JPEG 2000 images is currently limited to images that can fit in memory
In regards to metadata, most JP2 boxes are properly interpreted.
Certain optional JP2 boxes can also be written, including XML boxes and
XMP UUIDs. There is incomplete support for reading JPX metadata.
Glymur 0.6 works on Python versions 2.7, 3.3 and 3.4. If you have Python 2.6,
you should use the 0.5 series of Glymur.
For more information about OpenJPEG, please consult http://www.openjpeg.org.
Glymur Installation
===================
You can retrieve the source for Glymur from either of
* https://pypi.python.org/pypi/Glymur/ (stable releases)
* http://github.com/quintusdias/glymur (bleeding edge, use the devel branch)
but you should also be able to install Glymur via pip ::
$ pip install glymur
In addition to the package, this also gives you a script **jp2dump** that can
be used from the command line line to print JPEG 2000 metadata.