From 133205d66bc98669432f1d732abaf2a78fcf4e3b Mon Sep 17 00:00:00 2001 From: jevans Date: Tue, 20 May 2014 20:52:27 -0400 Subject: [PATCH] Changed look and feel of changelog to match 0.5.12. #237 --- docs/source/changelog.rst | 46 ----------------------- docs/source/detailed_installation.rst | 53 ++++++++++++++------------- docs/source/index.rst | 2 +- docs/source/introduction.rst | 6 +-- 4 files changed, 32 insertions(+), 75 deletions(-) delete mode 100644 docs/source/changelog.rst diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst deleted file mode 100644 index a24d1e8..0000000 --- a/docs/source/changelog.rst +++ /dev/null @@ -1,46 +0,0 @@ ---------- -ChangeLog ---------- - -0.6.0 -===== - - * Added support for OpenJPEG 2.1.0, dropped support for 1.3 and 1.4. - * Added Cinema2K, Cinema4K write support. - * Added lxml requirement. - * added set_printoptions, get_printoptions function - * dropped support for Python 2.6, added support for Python 3.4 - * dropped windows support (it might work, it might not, I don't much care) - * added write support for JP2 UUID, dataEntryURL, palette, and component mapping boxes - * added read/write support for JPX free, number list, and data reference boxes - * Added read support for JPX fragment list and fragment table boxes - * incompatible change to channel definition box constructor, channel_type and association are no longer keyword arguments - * incompatible change to palette box constructor, it now takes a 2D numpy array instead of a list of 1D arrays - -0.5.0 (September 16, 2013) -========================== - - * added write support when using OpenJPEG version 1.5 - * added version module - -0.4.0 (August 18, 2013) -========================== - - * added append method - -0.3.0 (July 31, 2013) -========================== - - * added support for OpenJPEG library version 2.0.0 - -0.2.0 (July 11, 2013) -========================== - - * added Python 2.6, Python 2.7 on windows - * read/write using OpenJPEG library version 2.0.0 - * read using OpenJPEG 1.4 - -0.1.0 (May 27, 2013) -==================== - - * first release using development version (2.x) of OpenJPEG diff --git a/docs/source/detailed_installation.rst b/docs/source/detailed_installation.rst index e919681..ecf0632 100644 --- a/docs/source/detailed_installation.rst +++ b/docs/source/detailed_installation.rst @@ -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 ... :: diff --git a/docs/source/index.rst b/docs/source/index.rst index 792f75a..fbc8fce 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,8 +16,8 @@ Contents: detailed_installation how_do_i roadmap - changelog api + whatsnew/index ------------------ Indices and tables diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 10df117..d4eee13 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -3,13 +3,13 @@ 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 within Python. +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 some very limited support for reading JPX metadata. +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. @@ -21,7 +21,7 @@ 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) + * http://github.com/quintusdias/glymur (bleeding edge, use the devel branch) but you should also be able to install Glymur via pip ::