Skip to content

Commit

Permalink
REL: Should be good for v0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
bskinn committed Aug 28, 2016
1 parent 0cabdf3 commit f3679a0
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 7 deletions.
34 changes: 34 additions & 0 deletions CHANGELOG.txt
Original file line number Diff line number Diff line change
@@ -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

13 changes: 7 additions & 6 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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'),
]

Expand All @@ -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)}

2 changes: 2 additions & 0 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
Welcome to h5cube's documentation!
==================================

*Pending...*

Contents:

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
setup(
name='h5cube',
version='0.1',
# requires='h5py something, pending tox',
requires='h5py (>=2.4)',
packages=['h5cube'],
url='https://www.github.com/bskinn/h5cube',
license='MIT License',
Expand Down

0 comments on commit f3679a0

Please sign in to comment.