jyapayne/glymur
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated docs for 2.0 support. #90

Browse source
This commit is contained in:
jevans 2013-07-29 19:48:21 -04:00
commit 39ae3d423b
2 changed files with 19 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/source/detailed_installation.rst
View file

@ -9,13 +9,14 @@ Glymur Configuration
The default glymur installation process relies upon OpenJPEG version The default glymur installation process relies upon OpenJPEG version
1.X being properly installed on your system. This will, however, only 1.X being properly installed on your system. This will, however, only
give you you basic read capabilities, so if you wish to take advantage give you you basic read capabilities, so if you wish to take advantage
of more of glymur's features, you should compile OpenJPEG as a shared of more of glymur's features, you should install version 2.0 or
library (named *openjp2* instead of *openjpeg*) from the developmental compile OpenJPEG as a shared library (named *openjp2* instead of
source that you can retrieve via subversion. As of this time of writing, *openjpeg*) from the developmental source that you can retrieve via
svn revision 2345 works. You should also download the test data for subversion. As of this time of writing, svn revision 2345 works.
the purpose of configuring and running OpenJPEG's test suite, check You should also download the test data for the purpose of configuring
their instructions for all this. You should set the **OPJ_DATA_ROOT** and running OpenJPEG's test suite, check their instructions for all
environment variable for the purpose of running Glymur's test suite. :: this. You should set the **OPJ_DATA_ROOT** environment variable
for the purpose of running Glymur's test suite. ::
$ svn co http://openjpeg.googlecode.com/svn/data $ svn co http://openjpeg.googlecode.com/svn/data
$ export OPJ_DATA_ROOT=`pwd`/data $ export OPJ_DATA_ROOT=`pwd`/data
@ -40,8 +41,8 @@ but if you have **$XDG_CONFIG_HOME** defined, the path will be ::
$XDG_CONFIG_HOME/glymur/glymurrc $XDG_CONFIG_HOME/glymur/glymurrc
On windows, the path to the configuration file can be determined by starting up Python On windows, the path to the configuration file can be determined
and typing :: by starting up Python and typing ::
import os import os
os.path.join(os.path.expanduser('~'), 'glymur', 'glymurrc') os.path.join(os.path.expanduser('~'), 'glymur', 'glymurrc')
@ -75,9 +76,7 @@ MacPorts. You should install the following set of ports:
* py33-matplotlib (optional, for running certain tests) * py33-matplotlib (optional, for running certain tests)
* py33-Pillow (optional, for running certain tests) * py33-Pillow (optional, for running certain tests)
MacPorts supplies both OpenJPEG 1.5.0 and OpenJPEG 2.0.0. As previously MacPorts supplies both OpenJPEG 1.5.0 and OpenJPEG 2.0.0.
mentioned, the 2.0.0 official release is not supported (although the 2.0+
development version via SVN *is* supported).
Linux Linux
----- -----

17
docs/source/introduction.rst
View file

@ -14,22 +14,21 @@ some very limited support for reading JPX metadata. For instance,
**asoc** and **labl** boxes are recognized, so GMLJP2 metadata can **asoc** and **labl** boxes are recognized, so GMLJP2 metadata can
be retrieved from such JPX files. be retrieved from such JPX files.
Glymur works on Python 2.6, 2.7, and 3.3. Python 3.3 is strongly recommended. Glymur works on Python 2.6, 2.7, and 3.3.
OpenJPEG Installation OpenJPEG Installation
===================== =====================
OpenJPEG should be version 1.4, 1.5, or the trunk/development Glymur will read JPEG 2000 images with versions 1.3, 1.4, 1.5, 2.0,
version of OpenJPEG. The official 2.0.0 release or versions earlier than 1.3.0 and the trunk/development version of OpenJPEG. Writing images is
are not supported. Furthermore, the 1.X versions of OpenJPEG are only supported with the 2.0 series, however, and the trunk/development
currently only utilized for read-only purposes. In order to write JPEG 2000 version is strongly recommended. For more information about OpenJPEG,
images, you must compile the the trunk/development version. For more information please consult http://www.openjpeg.org.
about OpenJPEG, please consult http://www.openjpeg.org.
If you use MacPorts on the mac or if you have a sufficiently recent If you use MacPorts on the mac or if you have a sufficiently recent
version of Linux, your package manager should already provide you version of Linux, your package manager should already provide you
with a version of OpenJPEG 1.X with which glymur can already use with a version of OpenJPEG 1.X with which glymur can already use
for read-only purposes. If your platform is windows, I suggest for read-only purposes. If your platform is windows, I suggest
using the 1.5.1 windows installer provided to you by the OpenJPEG using the windows installers provided to you by the OpenJPEG
folks at https://code.google.com/p/openjpeg/downloads/list . folks at https://code.google.com/p/openjpeg/downloads/list .
Glymur Installation Glymur Installation
@ -57,5 +56,5 @@ You can run the tests from within python as follows::
>>> glymur.runtests() >>> glymur.runtests()
Many tests are currently skipped; in fact most of them are skipped if you Many tests are currently skipped; in fact most of them are skipped if you
are relying on OpenJPEG 1.4 or 1.5. The important thing, though, is whether or are relying on OpenJPEG 1.X. The important thing, though, is whether or
not any tests fail. not any tests fail.