housecleaning for 0.7.0 release

This commit is contained in:
John Evans 2014-09-25 09:12:46 -04:00
commit 873bb0c900
10 changed files with 40 additions and 15 deletions

View file

@ -76,9 +76,9 @@ copyright = u'2013, John Evans'
# built documents.
#
# The short X.Y version.
version = '0.6'
version = '0.7'
# The full version, including alpha/beta/rc tags.
release = '0.6.0'
release = '0.7.0rc1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

View file

@ -3,11 +3,12 @@ How do I...?
------------
... read the lower resolution images?
=====================================
Jp2k implements slicing via the :py:meth:`__getitem__` method so
any lower resolution images in a JPEG 2000 file can easily be
accessed, for example here's how to retrieve the first sub-image ::
... read images?
================
Jp2k implements slicing via the :py:meth:`__getitem__` method, meaning that
multiple resolution imagery in a JPEG 2000 file can
easily be accessed. For example here's how to retrieve a full resolution and
first lower-resolution image ::
>>> import glymur
>>> jp2file = glymur.data.nemo()
@ -24,15 +25,16 @@ such as quality layers.
... display metadata?
=====================
There are two ways. From the command line, the script **jp2dump** is
There are two ways. From the command line, the console script **jp2dump** is
available. ::
$ jp2dump /path/to/glymur/installation/data/nemo.jp2
From within Python, it is as simple as printing the Jp2k object, i.e. ::
From within Python, the same result is obtained simply by printing the Jp2k
object, i.e. ::
>>> import glymur
>>> jp2file = glymur.data.nemo()
>>> jp2file = glymur.data.nemo() # just a path to a JP2 file
>>> jp2 = glymur.Jp2k(jp2file)
>>> print(jp2)
File: nemo.jp2

View file

@ -15,9 +15,9 @@ Contents:
introduction
detailed_installation
how_do_i
api
whatsnew/index
roadmap
api
------------------
Indices and tables

View file

@ -27,5 +27,6 @@ but you should also be able to install Glymur via pip ::
$ pip install glymur
In addition to the package, this also gives you a script **jp2dump** that can
be used from the command line line to print JPEG 2000 metadata.
In addition to the package, this also gives you a command line script
**jp2dump** that can be used from the command line line to print JPEG 2000
metadata.

View file

@ -1,3 +1,10 @@
-------------------------------------
Platforms Tested (0.7.0 release only)
-------------------------------------
* Linux Mint 17 / Python 3.4.0
* Linux Mint 17 / Python 2.7.6
* MacOS 10.6.8 / MacPorts / Python 3.4.1
------------
Known Issues
------------

View file

@ -0,0 +1,11 @@
=====================
Changes in glymur 0.7
=====================
Changes in 0.7.0
=================
* implemented :py:meth:`__getitem__`, :py:meth:`__setitem__` support
* added back windows support
* box_id and longname are class attributes now instead of instance
attributes (see issue 248)

View file

@ -10,3 +10,4 @@ These document the changes between minor (or major) versions of glymur.
0.5
0.6
0.7