Initial commit.

docs/source/api.rst

@@ -0,0 +1,5 @@
+API
+===
+
+.. autoclass:: glymur.Jp2k
+   :members:

docs/source/conf.py

@@ -0,0 +1,248 @@
+# -*- coding: utf-8 -*-
+#
+# glymur documentation build configuration file, created by
+# sphinx-quickstart on Sun May 26 11:29:54 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
+              'sphinx.ext.autosummary',
+              'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'numpydoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'glymur'
+copyright = u'2013, John Evans'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.0.a1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'glymurdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'glymur.tex', u'glymur Documentation',
+   u'John Evans', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'glymur', u'glymur Documentation',
+     [u'John Evans'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'glymur', u'glymur Documentation',
+   u'John Evans', 'glymur', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}

docs/source/how_do_i.rst

@@ -0,0 +1,24 @@
+************
+How do I...?
+************
+
+Display metadata?
+=================
+There are two ways.  From the unix command line, the 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.::
+
+    >>> import pkg_resources
+    >>> from glymur import Jp2k
+    >>> file = pkg_resources.resource_filename(glymur.__name__, "data/nemo.jp2")
+    >>> j = Jp2k(file)
+    >>> print(j)
+
+The primary emphasis is on JP2 metadata, but it is possible to
+display raw codestream as well::
+
+    >>> print(j.get_codestream())
+

docs/source/index.rst

@@ -0,0 +1,25 @@
+.. glymur documentation master file, created by
+   sphinx-quickstart on Thu Jan 24 16:44:44 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to glymur's documentation!
+===================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   introduction
+   api
+   how_do_i
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

docs/source/introduction.rst

@@ -0,0 +1,187 @@
+=========================================
+glymur: a Python interface for JPEG 2000
+=========================================
+
+**glymur** contains a Python interface to the OpenJPEG library
+which allows linux and mac users to read and write JPEG 2000 files.  For more
+information about OpenJPEG, please consult http://www.openjpeg.org.  **glymur**
+should be considered to be alpha-quality software.
+
+**glymur** tries to support reading (including all metadata) and writing of
+JP2 and J2C files.  Writing J2C/JP2 files is currently limited to images that
+can fit in memory, however.
+
+There is 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.
+
+------------
+Requirements
+------------
+**glymur** works on Python 2.7 and 3.3.  Python 3.3 is strongly recommended.
+
+OpenJPEG
+========
+OpenJPEG must be built as a shared library.  In addition, you
+currently must compile OpenJPEG from the developmental source that
+you can retrieve via subversion.  As of this time of writing, svn 
+revision 2345 works.  In addition, you should also retrieve their test data, as
+you will need it when running **glymur**'s test suite.
+
+Earlier versions of OpenJPEG through the 2.0 official release are not supported.
+
+Be sure to have the following ports/RPMs/debs installed.
+
+    * gcc
+    * gcc-c++
+    * cmake
+    
+You should build OpenJPEG with testing turned on.  Consult the OpenJPEG 
+documentation on how to do this.  If you use linux, make sure that you 
+have the following development packages installed
+
+    * zlib-devel
+    * png-devel
+    * libtiff-devel
+    * lcms2-devel
+
+OS
+==
+
+Mac OS X
+--------
+All the necessary packages are available to use **glymur** with Python 3.3 via
+MacPorts.  A minimal set of ports includes
+
+      * python33
+      * py33-numpy
+      * py33-distribute
+
+To run all the testing, one of the following combinations of ports must
+additionally be installed:
+
+      * py33-scikit-image and either py33-Pillow or freeimage
+      * py33-matplotlib and py33-Pillow
+
+Linux
+-----
+
+Fedora 18
+'''''''''
+Fedora 18 ships with Python 3.3, so all the necessary RPMs are available to 
+meet the minimal set of requirements.
+
+      * python3 
+      * python3-numpy
+      * python3-setuptools
+      * python3-matplotlib (for running tests)
+      * python3-matplotlib-tk (or whichever matplotlib backend you prefer)
+
+A few tests still will not run, however, unless one of the following
+combinations of RPMs / Python packages is installed.
+
+      * scikit-image and either Pillow or freeimage
+      * matplotlib and Pillow
+
+The 2nd route is probably the easiest, so go ahead and install **Pillow**
+via **pip** since **Pillow** is not yet available in Fedora 18 default
+repositories::
+
+    $ yum install python3-devel       # pip needs this in order to compile Pillow
+    $ yum install python3-pip         # First one must install pip of course!
+    $ pip-python3 install Pillow --user
+    $ export PYTHONPATH=$HOME/.local/lib/python3.3/site-packages:$PYTHONPATH
+
+Fedora 17
+'''''''''
+Fedora 17 ships with Python 3.2 and 2.7, so these steps detail working with 
+2.7.  
+
+Required RPMs include::
+
+      * python
+      * python-mock
+      * python-pip
+      * python-setuptools
+      * numpy
+
+In addition, you must install **contextlib2** via pip.
+
+A few tests still will not run, however, unless one of the following 
+combinations of RPMs / Python packages is installed.
+
+      * scikit-image and either Pillow or freeimage
+      * matplotlib and Pillow
+
+**scikit-image** is not available in the Fedora 17 default repositories, but 
+it may be installed via **pip**::
+
+    $ yum install Cython       # pip needs this in order to compile scikit-image
+    $ yum install python-devel # pip needs this in order to compile scikit-image
+    $ yum install freeimage    # scikit-image uses this as a backend
+    $ yum install scipy        # needed by scikit-image
+    $ pip-python install scikit-image --user
+    $ pip-python install contextlib2 --user
+    $ export PYTHONPATH=$HOME/.local/lib/python2.7/site-packages:$PYTHONPATH
+
+Windows
+-------
+Not currently supported.
+
+------------------------------------
+Installation, Testing, Configuration
+------------------------------------
+
+From this point forward, python3 will be referred to as just "python".
+
+Installation
+============
+
+In addition to merely installing **glymur**, you should adjust your **$PATH**
+environment variable in order to be able to use the **jp2dump** script from
+the unix command line.
+
+::
+
+    $ python setup.py install --prefix=/install/path
+    $ export PYTHONPATH=/install/path/lib/python3.3/site-packages
+    $ export PATH=/install/path/bin:$PATH
+
+
+Configuration
+=============
+glymur uses **ctypes** (for the moment) to access the openjp2 library, and
+because **ctypes** access libraries in a platform-dependent manner, it is 
+recommended that you create a configuration file to help glymur properly find
+the openjp2 library.  You may create the configuration file as follows::
+
+    $ mkdir ~/.glymur
+    $ cd ~/.glymur
+    $ cat > glymurrc << EOF
+    > [library]
+    > openjp2: /opt/openjp2-svn/lib/libopenjp2.so
+    > EOF
+
+That assumes, of course, that you've installed OpenJPEG into /opt/openjp2-svn.
+
+
+Testing
+=======
+In order to run all of the test suite, you will first need the OpenJPEG test
+data that you previously retrieved.
+Then you should set the **OPJ_DATA_ROOT** environment variable to
+point to this directory, e.g.::
+
+    $ cd /somewhere/outside/the/glymur/unpacking/directory
+    $ svn co http://openjpeg.googlecode.com/svn/data
+    $ export OPJ_DATA_ROOT=`pwd`/data
+
+The test suite may then be run with::
+
+    $ cd /back/to/glymur/unpacking/directory
+    $ python -m unittest discover
+
+At the moment, the development version of the library prints quite a few 
+warnings to stderr, which you may ignore.  There are also more skipped tests
+on Python 2.7 than on Python 3.3.  The important thing will be whether
+or not any test errors are reported at the end.