Merge branch 'release/v0.3.3'

Author: t-sommer

.gitignore

@@ -10,9 +10,6 @@
 # compiled code
 *.py[cod]
 
-# C extensions
-*.so
-
 # Packages
 *.egg
 *.egg-info

.travis.yml

@@ -0,0 +1,63 @@
+language: python
+
+matrix:
+  include:
+    - os: linux
+      env:
+        - PYTHON_VERSION=2.7
+        - MINICONDA=Miniconda2-latest-Linux-x86_64.sh
+
+    - os: linux
+      env:
+        - PYTHON_VERSION=3.6
+        - MINICONDA=Miniconda3-latest-Linux-x86_64.sh
+
+    - os: osx
+      language: generic
+      env:
+        - PYTHON_VERSION=2.7
+        - MINICONDA=Miniconda2-latest-MacOSX-x86_64.sh
+
+    - os: osx
+      language: generic
+      env:
+        - PYTHON_VERSION=3.6
+        - MINICONDA=Miniconda3-latest-MacOSX-x86_64.sh
+
+install:
+  # download and install miniconda
+  - wget https://repo.continuum.io/miniconda/$MINICONDA -O miniconda.sh
+  - bash miniconda.sh -b -p $HOME/miniconda
+  - export PATH="$HOME/miniconda/bin:$PATH"
+  - hash -r
+  - conda config --set always_yes yes --set changeps1 no
+  - conda update -q conda
+
+  # useful for debugging any issues with conda
+  - conda info -a
+
+  # create the conda environment
+  - conda create -q -n test-env python=$PYTHON_VERSION
+  - source activate test-env
+
+  # build the wheel
+  - python setup.py bdist_wheel --universal
+
+  # install the wheel and its dependencies
+  - |
+    for f in dist/SDF-*.whl; do
+      pip install $f
+    done
+
+script:
+  - cd tests
+  - python -m unittest discover
+  - cd ..
+
+deploy:
+  provider: pypi
+  user: t-sommer
+  password:
+    secure: H4EFw/NtTmmFLOB2yjP8d3uqsPDCzG4WV7RbeEu3rRwz39cZxKkBEvBokKYVPo7tLRwWTQjYGbrwOaLME3hBNo0Mjc9d99Ivcy6UTeE4T6AUln//STDOjy2geJnkBCStZ5I21N+bVom6lzT0Oe0EUnJNBQWnJza7EuMSoTdaH3us5Obtc3F1dqbUensdvaUUvZw9Px7lIQ2C1drwgZvh3yArXX8rVAtxq9wpa601G6tKtrwRcgS4v1jAK8p7MJdFVA/9i5ZAXB/L4waE3pv+k52bjFJ9lcaYOwYcxBedqriKYV78q0+VmBn1TfMK0oNEDgg7abVjZwnx17oGvm389BeEFzN7GXX3RsoNNUlcMFXEEaFVuCWwXNG3Sx6HHsz9zyOE6jbhMt1ag4VHZsCoWO/UoXL7jbd46kBIOuixVgkPZlQSP6FA0/jch85940tYtPQXBxldOiwjYyFFUxv/47iTaB0aAt6Elm+2c/dxgDd0jS/FwmGdChrYcjLU8qjy2/ApMps1C2u00nxN6P/OxqbY0fIqgBFHQOsEgEoSe6sGDzPTOtQrsp/3pP3At1KR8czBkTUxWb+5Xa+ObM/qc4Jcy3QAoLRlGIyId9frOpViI/VgM4RpT+i0chaOwY4yFAexkWwGtWST58VKgvnzYTtnTQ/g+fRgFal3NtkEWUo=
+  distributions: bdist_wheel --universal
+  skip_cleanup: true

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
+## [0.3.3] (2017-12-13)
+
+### Changed
+- Distribution package changed from .tar.gz to .whl (Python Wheel)
 
 ## [0.3.2] (2017-07-09)
+
 ### Added
 - Support for Linux and Mac

README.rst

@@ -1,41 +1,80 @@
 .. image:: https://ci.appveyor.com/api/projects/status/github/ScientificDataFormat/SDF-Python?branch=master
 
+
 Scientific Data Format for Python
 =================================
 
 SDF is a Python package to read, write and interpolate multi-dimensional data.
-The Scientific Data Format is an open file format based on HDF5 to store
-multi-dimensional data such as parameters, simulations results or measurements.
+The Scientific Data Format is an open file format based on HDF5_ to store
+multi-dimensional data such as parameters, simulation results or measurements.
 It supports...
 
 - very large files
 - up to 32 dimensions
 - hierarchical structure
 - units, comments and custom meta-information
 
-For detailed information see the SDF specification.
+For detailed information see the `SDF specification`_.
 
 
 Installation
 ------------
 
-Install the latest release from PyPI
+To install the latest release from `PyPI <https://pypi.python.org/pypi/sdf/>`_ or update an existing installation::
+
+    python -m pip install --upgrade sdf
+
+To install the latest development version::
+
+    python -m pip install --upgrade https://github.com/ScientificDataFormat/SDF-Python/archive/develop.zip
+
+
+Tutorial
+--------
+
+Import the ``SDF`` and ``NumPy`` packages:
+
+    >>> import sdf
+    >>> import numpy as np
+
+Create the data arrays:
+
+    >>> t = np.linspace(0, 10, 51)
+    >>> v = np.sin(t)
+
+Create the datasets:
+
+    >>> ds_t = sdf.Dataset('t', data=t, unit='s', is_scale=True, display_name='Time')
+    >>> ds_v = sdf.Dataset('v', data=v, unit='V', scales=[ds_t])
+
+Create the root group and write the file:
+
+    >>> g = sdf.Group('/', comment='A sine voltage', datasets=[ds_t, ds_v])
+    >>> sdf.save('sine.sdf', g)
+
+Read the dataset from the SDF file asserting the correct unit of the dataset and scale:
 
-::
+    >>> ds_v2 = sdf.load('sine.sdf', '/v', unit='V', scale_units=['s'])
 
-    $ sudo pip install sdf
+Get the meta info and data array from the dataset:
 
-or install the latest development version from source
+    >>> ds_v2.unit
+    'V'
+    >>> ds_v2.data.shape
+    (51,)
 
-::
+Get the scale for the first dimension:
 
-    $ git clone --branch develop --recursive https://github.com/ScientificDataFormat/SDF-Python.git
-    $ cd SDF-Python
-    $ sudo pip install .
+    >>> ds_t2 = ds_v2.scales[0]
+    >>> ds_t2.unit
+    's'
 
 
 -----------------------------
 
-|copy| 2017 Dassault Systèmes
+|copyright| 2017 |Dassault Systemes|
 
-.. |copy|   unicode:: U+000A9
+.. _SDF specification: https://github.com/ScientificDataFormat/SDF
+.. _HDF5: https://www.hdfgroup.org/hdf5/
+.. |copyright|   unicode:: U+000A9
+.. |Dassault Systemes| unicode:: Dassault U+0020 Syst U+00E8 mes

appveyor.yml

@@ -1,29 +1,42 @@
-image: Visual Studio 2015
-
 build: false
 
 environment:
+
   matrix:
     - PYTHON_VERSION: 2.7
       MINICONDA: C:\Miniconda
-    - PYTHON_VERSION: 3.4
-      MINICONDA: C:\Miniconda3
+
+    - PYTHON_VERSION: 3.5
+      MINICONDA: C:\Miniconda35
+
+    - PYTHON_VERSION: 2.7
+      MINICONDA: C:\Miniconda-x64
+
+    - PYTHON_VERSION: 3.5
+      MINICONDA: C:\Miniconda35-x64
 
 init:
-  - "echo %PYTHON_VERSION% %MINICONDA%"
+  - echo %PYTHON_VERSION% %MINICONDA%
 
 install:
-  - cmd: git submodule update --init --recursive
-  - "set PATH=%MINICONDA%;%MINICONDA%\\Scripts;%PATH%"
+  - git submodule update --init --recursive
+  - set PATH=%MINICONDA%;%MINICONDA%\\Scripts;%PATH%
   - conda config --set always_yes yes --set changeps1 no
   - conda update -q conda
   - conda info -a
-  - "conda create -q -n test-environment python=%PYTHON_VERSION% numpy h5py matplotlib scipy"
-  - activate test-environment
-  - pip install dymat
+  - conda create -q -n test-env python=%PYTHON_VERSION%
+  - activate test-env
+
+  # build the wheel
+  - python setup.py bdist_wheel --universal
+
+  # install the wheel and its dependencies
+  - for %%f in (dist\SDF-*.whl) do pip install %%f
 
 test_script:
-  - build_windows
-  - pip install .
   - cd tests
-  - python test_sdf.py
+  - python -m unittest discover
+
+artifacts:
+  # archive the generated wheel in the build report
+  - path: dist\*

requirements.txt

@@ -2,4 +2,4 @@ h5py
 matplotlib
 numpy
 xlrd
-DyMat
+scipy

sdf/__init__.py

@@ -7,7 +7,7 @@
 
 from . import hdf5
 
-__version__ = '0.3.2'
+__version__ = '0.3.3'
 
 _object_name_pattern = re.compile('[a-zA-Z][a-zA-Z0-9_]*')