Merge branch 'release-0.1'

.gitignore

@@ -88,7 +88,12 @@ ENV/
 # Rope project settings
 .ropeproject
 
-# CUBE and h5 files
-*.cube
-*.h5
+# gedit temp/bak files
+*.rst~
+*.py~
+.gitignore~
+
+# Misc .bak files
+*.bak
+
 

CHANGELOG.txt

@@ -0,0 +1,34 @@
+Changelog for h5cube
+
+
+v0.1
+================================================================================
+
+Initial beta release, without documentation or a test suite. Below functionality
+believed functional and substantially bug-free
+
+File extensions are fixed:
+
+ - .h5cube files (case insensitive) are decompressed
+ - .cube and .cub files (case insensitive) are compressed
+
+Clobber of an existing output file always occurs. No options are available for
+selecting/changing the name of the output file.
+
+* General options
+  --delete, optionally delete the source file after (de)compression
+
+* Compression options
+  --compress, gzip compression level within the HDF5 file
+  --truncate, truncated precision of the log-10 mantissa of each data value
+  * Thresholding options
+    --absolute / --signed, whether indicated threshold values are applied to
+                           the signed value or the absolute magnitude
+    --minmax / --isofactor, whether the threshold values are specified by
+                            explicit min/max values, or a central isovalue
+			    and a multiplicative factor
+
+* Decompression options
+  --precision, the significant figures past the decimal point output for
+               each data point
+

README.rst

@@ -0,0 +1,19 @@
+Gaussian CUBE Compression via h5py
+==================================
+
+Compression/decompression command-line tool and Python package for
+Gaussian CUBE files, exploiting the capabilities of the
+`HDF5 <http://www.h5py.org/>`__ binary format via ``h5py``.
+
+Available on `PyPI <https://pypi.python.org/pypi/h5cube>`__
+(``pip install h5cube``).
+
+Source on `GitHub <https://github.com/bskinn/h5cube>`__.
+
+Documentation at Read the Docs:
+
+.. image:: https://readthedocs.org/projects/h5cube/badge/?version=latest
+    :target: http://h5cube.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+

doc/source/conf.py

@@ -25,7 +25,7 @@
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
-# needs_sphinx = '1.0'
+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
@@ -65,9 +65,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.0'
+version = '0.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.0'
+release = '0.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -127,7 +127,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # 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
@@ -325,7 +325,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'h5cube', 'h5cube Documentation',
-     author, 'h5cube', 'One line description of project.',
+     author, 'h5cube', 'Gaussian CUBE file compression via h5py',
      'Miscellaneous'),
 ]
 
@@ -347,4 +347,5 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/3.5', None)}
+

doc/source/index.rst

@@ -6,6 +6,8 @@
 Welcome to h5cube's documentation!
 ==================================
 
+*Pending...*
+
 Contents:
 
 .. toctree::

h5cube/__init__.py

@@ -0,0 +1,21 @@
+# ------------------------------------------------------------------------------
+# Name:        init
+# Purpose:     Package information for h5cube
+#
+# Author:      Brian Skinn
+#                bskinn@alum.mit.edu
+#
+# Created:     22 Aug 2016
+# Copyright:   (c) Brian Skinn 2016
+# License:     The MIT License; see "license.txt" for full license terms
+#                   and contributor agreement.
+#
+#       http://www.github.com/bskinn/h5cube
+#
+# ------------------------------------------------------------------------------
+
+from __future__ import absolute_import
+
+from .h5cube import cube_to_h5, h5_to_cube, H5, EXIT
+
+__version__ = '0.1'