From 4697a106d1f4a0a77d8a5884e34606a316a7d524 Mon Sep 17 00:00:00 2001 From: jevans Date: Thu, 18 Jul 2013 18:24:18 -0400 Subject: [PATCH] Minor doc updates. --- docs/source/detailed_installation.rst | 12 +++++++----- docs/source/how_do_i.rst | 4 ++-- docs/source/introduction.rst | 18 ++++++++++-------- 3 files changed, 19 insertions(+), 15 deletions(-) diff --git a/docs/source/detailed_installation.rst b/docs/source/detailed_installation.rst index bacf3c5..14cf4d6 100644 --- a/docs/source/detailed_installation.rst +++ b/docs/source/detailed_installation.rst @@ -7,7 +7,7 @@ Glymur Configuration '''''''''''''''''''''' The default glymur installation process relies upon OpenJPEG version -1.4 or 1.5 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 of more of glymur's features, you should compile OpenJPEG as a shared library (named *openjp2* instead of *openjpeg*) from the developmental @@ -88,7 +88,10 @@ meet the minimal set of requirements for running glymur. * python3 * python3-numpy * python3-setuptools - * python3-matplotlib (for running tests) + +For running the maximal number of tests, you also need + + * python3-matplotlib * python3-matplotlib-tk (or whichever matplotlib backend you prefer) Pillow is also needed in order to run the maximum number of tests, so @@ -102,9 +105,8 @@ in Fedora 18 default repositories:: Fedora 17 ''''''''' -Fedora 17 ships with Python 2.7 and OpenJPEG 1.4. - -Required RPMs include:: +Fedora 17 ships with Python 2.7 and OpenJPEG 1.4. You should have the +following RPMs installed. * python * python-mock diff --git a/docs/source/how_do_i.rst b/docs/source/how_do_i.rst index 2a1576f..8abb693 100644 --- a/docs/source/how_do_i.rst +++ b/docs/source/how_do_i.rst @@ -38,8 +38,8 @@ Add XML Metadata? ================= An existing raw codestream (or JP2 file) can be wrapped (re-wrapped) in a user-defined set of JP2 boxes. To get just a minimal JP2 jacket on the -codestream provided by `goodstuff.j2k`, you can use the **wrap** method with -no box argument: :: +codestream provided by `goodstuff.j2k` (a file consisting of a raw codestream), +you can use the **wrap** method with no box argument: :: >>> import glymur >>> jfile = glymur.data.goodstuff() diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 9cb1421..00d029e 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -18,17 +18,19 @@ Glymur works on Python 2.6, 2.7, and 3.3. Python 3.3 is strongly recommended. OpenJPEG Installation ===================== -The OpenJPEG library version should be 1.4, 1.5, or the trunk/development +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.4 and 1.5 versions of OpenJPEG are -currently only utilized for read-only purposes. For more information +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. -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 with which glymur can already use. If your platform is -windows, I suggest using the 1.5.1 windows installer provided to you by -the OpenJPEG folks at https://code.google.com/p/openjpeg/downloads/list . +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 +folks at https://code.google.com/p/openjpeg/downloads/list . Glymur Installation ===================