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

Changed look and feel of changelog to match 0.5.12. #237

Browse source
This commit is contained in:
jevans 2014-05-20 20:52:27 -04:00
commit 133205d66b
4 changed files with 32 additions and 75 deletions
Download patch file Download diff file Expand all files Collapse all files

53
docs/source/detailed_installation.rst
View file

@ -6,25 +6,22 @@ Advanced Installation Instructions
Glymur Configuration
''''''''''''''''''''''
The default glymur installation process relies upon OpenJPEG
being properly installed on your system. If you have version 1.5 you can
both read and write JPEG 2000 files, but version 2.1 is recommended.
If you compile OpenJPEG yourself, please compile it as a shared library.
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. ::
The default glymur installation process relies upon OpenJPEG being
properly installed on your system as a shared library. If you have
OpenJPEG installed through your system’s package manager on linux
or if you use MacPorts on the mac, you are probably already set to
go. But if you have OpenJPEG installed into a non-standard place
or if you use windows, then read on.
$ svn co http://openjpeg.googlecode.com/svn/data
$ export OPJ_DATA_ROOT=`pwd`/data
Glymur uses ctypes to access the openjp2/openjpeg libraries,
and because ctypes accesses libraries in a platform-dependent manner, it is
recommended that you create a configuration file to help Glymur properly find
the openjpeg or openjp2 libraries (linux users don't need to bother with this
if you are using OpenJPEG as provided by your package manager). The
configuration format is the same as used by Python's configparser module,
i.e. ::
Glymur uses ctypes to access the openjp2/openjpeg libraries, and
because ctypes accesses libraries in a platform-dependent manner,
it is recommended that if you compile and install OpenJPEG into a
non-standard location, you should then create a configuration file
to help Glymur properly find the openjpeg or openjp2 libraries
(linux users or macports users don’t need to bother with this if
you are using OpenJPEG as provided by your package manager). The
configuration format is the same as used by Python’s configparser
module, i.e. ::
[library]
openjp2: /opt/openjp2-svn/lib/libopenjp2.so
@ -41,6 +38,12 @@ 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 ::
import os
os.path.join(os.path.expanduser('~', 'glymur', 'glymurrc')
You may also include a line for the version 1.x openjpeg library if you have it
installed in a non-standard place, i.e. ::
@ -51,14 +54,14 @@ installed in a non-standard place, i.e. ::
Testing
'''''''
There are two environment variables you may wish to set before running the
tests.
It is not necessary, but you may wish to download OpenJPEG's test
data for the purpose of configuring and running OpenJPEG's test
suite. Check their instructions on how to do that. You can then
set the **OPJ_DATA_ROOT** environment variable for the purpose of
pointing Glymur to OpenJPEG's test suite. ::
* **OPJ_DATA_ROOT** - points to directory for OpenJPEG test data (see above)
* **FORMAT_CORPUS_DATA_ROOT** - points to directory for format-corpus repository (see https://github.com/openplanets/format-corpus if you wish, but you really don't need to bother with this)
Setting these two environment variables is not required, as any tests using
either of them will be skipped.
$ svn co http://openjpeg.googlecode.com/svn/data
$ export OPJ_DATA_ROOT=`pwd`/data
In order to run the tests, you can either run them from within
python as follows ... ::