From 39ae3d423b15e885c4d7d60a27d0d48829d8e6ea Mon Sep 17 00:00:00 2001 From: jevans Date: Mon, 29 Jul 2013 19:48:21 -0400 Subject: [PATCH] Updated docs for 2.0 support. #90 --- docs/source/detailed_installation.rst | 23 +++++++++++------------ docs/source/introduction.rst | 17 ++++++++--------- 2 files changed, 19 insertions(+), 21 deletions(-) diff --git a/docs/source/detailed_installation.rst b/docs/source/detailed_installation.rst index 165868f..84fe887 100644 --- a/docs/source/detailed_installation.rst +++ b/docs/source/detailed_installation.rst @@ -9,13 +9,14 @@ Glymur Configuration The default glymur installation process relies upon OpenJPEG version 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 -of more of glymur's features, you should compile OpenJPEG as a shared -library (named *openjp2* instead of *openjpeg*) from the developmental -source that you can retrieve via subversion. As of this time of writing, -svn revision 2345 works. You should also download the test data for -the purpose of configuring and running OpenJPEG's test suite, check -their instructions for all this. You should set the **OPJ_DATA_ROOT** -environment variable for the purpose of running Glymur's test suite. :: +of more of glymur's features, you should install version 2.0 or +compile OpenJPEG as a shared library (named *openjp2* instead of +*openjpeg*) from the developmental source that you can retrieve via +subversion. As of this time of writing, svn revision 2345 works. +You should also download the test data for the purpose of configuring +and running OpenJPEG's test suite, check their instructions for all +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 $ 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 -On windows, the path to the configuration file can be determined by starting up Python -and typing :: +On windows, the path to the configuration file can be determined +by starting up Python and typing :: import os 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-Pillow (optional, for running certain tests) -MacPorts supplies both OpenJPEG 1.5.0 and OpenJPEG 2.0.0. As previously -mentioned, the 2.0.0 official release is not supported (although the 2.0+ -development version via SVN *is* supported). +MacPorts supplies both OpenJPEG 1.5.0 and OpenJPEG 2.0.0. Linux ----- diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 00d029e..0a59ebd 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -14,22 +14,21 @@ some very limited support for reading JPX metadata. For instance, **asoc** and **labl** boxes are recognized, so GMLJP2 metadata can 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 should be version 1.4, 1.5, or the trunk/development -version of OpenJPEG. The official 2.0.0 release or versions earlier than 1.3.0 -are not supported. Furthermore, the 1.X versions of OpenJPEG are -currently only utilized for read-only purposes. In order to write JPEG 2000 -images, you must compile the the trunk/development version. For more information -about OpenJPEG, please consult http://www.openjpeg.org. +Glymur will read JPEG 2000 images with versions 1.3, 1.4, 1.5, 2.0, +and the trunk/development version of OpenJPEG. Writing images is +only supported with the 2.0 series, however, and the trunk/development +version is strongly recommended. For more information about OpenJPEG, +please consult http://www.openjpeg.org. If you use MacPorts on the mac or if you have a sufficiently recent version of Linux, your package manager should already provide you with a version of OpenJPEG 1.X with which glymur can already use 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 . Glymur Installation @@ -57,5 +56,5 @@ You can run the tests from within python as follows:: >>> glymur.runtests() 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.