[python-hdf5storage] 35/152: Added package installer (distutils) and wrote Readme.
Ghislain Vaillant
ghisvail-guest at moszumanska.debian.org
Mon Feb 29 08:24:32 UTC 2016
This is an automated email from the git hooks/post-receive script.
ghisvail-guest pushed a commit to annotated tag 0.1
in repository python-hdf5storage.
commit 54e13e832dbc34fe020a6c6329d61ec91ff4c7ba
Author: Freja Nordsiek <fnordsie at gmail.com>
Date: Sun Jan 26 20:06:36 2014 -0500
Added package installer (distutils) and wrote Readme.
---
MANIFEST.in | 3 ++
README.md | 4 ---
README.rst | 112 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
setup.py | 27 +++++++++++++++
4 files changed, 142 insertions(+), 4 deletions(-)
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..560f8ef
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,3 @@
+include *.txt
+include *.md
+include *.rst
diff --git a/README.md b/README.md
deleted file mode 100644
index e4b451e..0000000
--- a/README.md
+++ /dev/null
@@ -1,4 +0,0 @@
-hdf5storage
-===========
-
-Python package to read and write a wide range of Python types to/from HDF5 formatted files.
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..9853bcc
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,112 @@
+Overview
+========
+
+This Python package provides high level utilities to read/write a
+variety of Python types to/from HDF5 (Heirarchal Data Format) formatted
+files. This package also provides support for MATLAB MAT v7.3 formatted
+files, which are just HDF5 files with a different extension and some
+extra meta-data.
+
+The package's source code is found at
+https://github.com/frejanordsiek/hdf5storage
+
+Installation
+============
+
+This package will not work on Python < 3.0.
+
+This package requires the numpy and h5py (>= 2.0) packages.
+
+To install hdf5storage, download the package and run the command::
+
+ python3 setup.py install
+
+Hierarchal Data Format 5 (HDF5)
+===============================
+
+HDF5 files (see http://www.hdfgroup.org/HDF5/) are a commonly used file
+format for exchange of numerical data. It has built in support for a
+large variety of number formats (un/signed integers, floating point
+numbers, strings, etc.) as scalars and arrays, enums and compound types.
+It also handles differences in data representation on different hardware
+platforms (endianness, different floating point formats, etc.). As can
+be imagined from the name, data is represented in an HDF5 file in a
+hierarchal form modelling a Unix filesystem (Datasets are equivalent to
+files, Groups are equivalent to directories, and links are supported).
+
+This package interfaces HDF5 files using the h5py package
+(http://www.h5py.org/) as opposed to the tables package
+(http://www.pytables.org/).
+
+MATLAB MAT v7.3 file support
+============================
+
+MATLAB (http://www.mathworks.com/) MAT files version 7.3 and later are
+HDF5 files with a different file extension (``.mat``) and a very
+specific set of meta-data and storage conventions. This package provides
+read and write support for a limited set of Python and MATLAB types.
+
+Supported Types
+===============
+
+The supported Python and MATLAB types are given in the tables below. The
+first table gives which Python types can be read and written, the
+first version of this package to support it, the MATLAB class it
+becomes if targetting a MAT file, and the first version of this
+package to support writing it so MATlAB can read it. The second table
+gives the MATLAB classes that can be read from a MAT file, the first
+version of this package that can read them, and the Python type they
+are read as. The tables assume that one has imported numpy as::
+
+ import numpy as np
+
+============= ======= ======= ========
+Python MATLAB
+---------------------- -----------------
+Type Version Class Version
+============= ======= ======= ========
+bool 0.1 logical 0.1
+None 0.1 [] 0.1
+int 0.1 int64 0.1
+float 0.1 double 0.1
+complex 0.1 double 0.1
+str 0.1 char 0.1 [1]_
+bytes 0.1 char 0.1
+bytearray 0.1 char 0.1
+np.bool_ 0.1 logical 0.1
+np.uint8 0.1 uint8 0.1
+np.float16 0.1
+np.float32 0.1 single 0.1
+np.float64 0.1 double 0.1
+np.complex32 0.1
+np.complex64 0.1 single 0.1
+np.complex128 0.1 double 0.1
+np.str_ 0.1 uint32 0.1 [2]_
+np.bytes_ 0.1 char 0.1
+dict 0.1 struct 0.1 [3]_
+============= ======= ======= ========
+
+
+============ ======= ================================
+MATLAB Class Version Python Type
+============ ======= ================================
+logical 0.1 np.bool_
+single 0.1 np.float32 or np.complex64 [4]_
+double 0.1 np.float64 or np.complex128 [4]_
+uint8 0.1 np.uint8
+uint16 0.1 np.uint16
+uint32 0.1 np.uint32
+uint64 0.1 np.uint64
+int8 0.1 np.int8
+int16 0.1 np.int16
+int32 0.1 np.int32
+int64 0.1 np.int64
+struct 0.1 dict [5]_
+============ ======= ================================
+
+
+.. [1] Converted to ASCII, so characters outside of that set are lost.
+.. [2] Simply copied over as the uint32 versions of each UTF-32 character.
+.. [3] All keys must be ``str``.
+.. [4] Depends on whether there is a complex part or not.
+.. [5] Structure arrays are not supported.
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..6607a52
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,27 @@
+from distutils.core import setup
+
+with open('README.rst') as file:
+ long_description = file.read()
+
+setup(name='hdf5storage',
+ version='0.1',
+ description='Utilities to read/write Python types to HDF5 files.',
+ long_description=long_description,
+ author='Freja Nordsiek',
+ author_email='fnordsie at gmail dt com',
+ url='https://github.com/frejanordsiek/hdf5storage',
+ packages=['hdf5storage'],
+ requires=['numpy', 'h5py (>= 2.0)'],
+ classifiers=[
+ "Programming Language :: Python :: 3",
+ "Development Status :: 3 - Alpha",
+ "License :: OSI Approved :: BSD License",
+ "Operating System :: OS Independent",
+ "Intended Audience :: Developers",
+ "Intended Audience :: Information Technology",
+ "Intended Audience :: Science/Research",
+ "Topic :: Scientific/Engineering",
+ "Topic :: Database",
+ "Topic :: Software Development :: Libraries :: Python Modules"
+ ]
+ )
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/python-hdf5storage.git
More information about the debian-science-commits
mailing list