hdf5 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b76ea3b42ccf86604529277254fa03b47a96f8e6
-  data.tar.gz: 7985f052f51e4009b073ea45c7afdcc8c7ac3528
+  metadata.gz: 2befee7acbf6e2e264a2d69b952b05f76f96d0ce
+  data.tar.gz: 87178ddd83a7643fc28581c4b59a1bc4ee4e1523
 SHA512:
-  metadata.gz: add84fdaf00b547fcee48c08e8f9071628a3727317aa0f5ace801242f6138ee027d9c63d310889d2128a8b94459517cedbf8c1871e31a4a6e5d041bf1afd4c09
-  data.tar.gz: 729113fd282183c52306c6589763d011a4ac58e09da8273070db5024c552d397676fb49cff31893c8dda3daa3566011ab20cce7035c91b77e63be16dc9cc22df
+  metadata.gz: 06d14090eb43ee3ebc37007968261cfb6590f11a33685251fc0710dfa9e94257791952490b03f092cab6b04e514ba2dd598b8dd0124f464ac90968745dbc2328
+  data.tar.gz: 0e49116c3d162a22617fddc323592e247a27527b174291e4ce9db82f26bb1b8f7743100aada9adfb7f06e8eda00b012aaae72625de56500e1502414e72ae47f9

data/README.md

@@ -0,0 +1,52 @@
+
+Hdf5
+====
+
+This is a Ruby module for reading and manipulating HDF5 (Hierarchical Data Format) 
+files. At the current time (July 2014) it is capable of basic reading operations.
+However, its use of the FFI library means that extending its capabilities is easy
+and quick. 
+
+Installation
+------------
+
+Make sure you have libhdf5 installed on your system, then simply execute:
+
+    gem install hdf5
+
+Examples
+--------
+
+Basic usage: 
+
+    require 'hdf5'
+    file = Hdf5::H5File.new('filename.hdf5')
+    dataset = file.dataset('/path/to/dataset')
+    narray = dataset.narray_all
+    file.close
+
+Extended example:
+
+
+    require 'hdf5'
+
+    file = Hdf5::H5File.new('test/field.dat.h5') # Open an existing file readonly
+
+    ds = file.dataset('/field/phi/0000000000')  # Open a dataset
+    p ds.narray_type # Print the Ruby/NArray type of the dataset (if possible)
+
+    p dt = ds.datatype # Access the datatype
+    p dt.nmembers # Print the number of members of the datatype
+
+    p dsp = ds.dataspace # Access the dataspace
+    p dsp.ndims # Number of dimensions in dataspace
+    p dsp.dims # Array of dimension sizes
+    p dsp.maxdims # Array of max dimension sizes
+
+    p na = ds.narray_all  # Read the whole dataset into an narray
+
+    p na2 = ds.narray_simple_read([0,0,0], [0,0,0]) # Read one element of the dataset into an narray
+
+    p na3 = ds.narray_simple_read([1,0,0], [3,-1,-1]) # Read a section of the dataset into an narray
+
+    file.close # Close the file

data/README.rdoc

@@ -1,6 +1,51 @@
 = hdf5
 
-Description goes here.
+This is a Ruby module for reading and manipulating HDF5 (Hierarchical Data Format) 
+files. At the current time (July 2014) it is capable of basic reading operations.
+However, its use of the FFI library means that extending its capabilities is easy
+and quick. For a basic example see the test/test_hdf5.rb file on github.  
+
+== Installation
+
+Make sure you have libhdf5 installed on your system, then simply execute:
+
+    gem install hdf5
+
+== Examples
+
+Basic usage: 
+
+    require 'hdf5'
+    file = Hdf5::H5File.new('filename.hdf5')
+    dataset = file.dataset('/path/to/dataset')
+    narray = dataset.narray_all
+    file.close
+
+Extended example:
+
+
+    require 'hdf5'
+
+    file = Hdf5::H5File.new('test/field.dat.h5') # Open an existing file readonly
+
+    ds = file.dataset('/field/phi/0000000000')  # Open a dataset
+    p ds.narray_type # Print the Ruby/NArray type of the dataset (if possible)
+
+    p dt = ds.datatype # Access the datatype
+    p dt.nmembers # Print the number of members of the datatype
+
+    p dsp = ds.dataspace # Access the dataspace
+    p dsp.ndims # Number of dimensions in dataspace
+    p dsp.dims # Array of dimension sizes
+    p dsp.maxdims # Array of max dimension sizes
+
+    p na = ds.narray_all  # Read the whole dataset into an narray
+
+    p na2 = ds.narray_simple_read([0,0,0], [0,0,0]) # Read one element of the dataset into an narray
+
+    p na3 = ds.narray_simple_read([1,0,0], [3,-1,-1]) # Read a section of the dataset into an narray
+
+    file.close # Close the file
 
 == Contributing to hdf5
  

data/README.rdoc.orig

@@ -0,0 +1,19 @@
+= hdf5
+
+Description goes here.
+
+== Contributing to hdf5
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Edmund Highcock. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/hdf5.gemspec

@@ -2,12 +2,12 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: hdf5 0.3.3 ruby lib
+# stub: hdf5 0.3.4 ruby lib
 # stub: ext/hdf5/extconf.rb
 
 Gem::Specification.new do |s|
   s.name = "hdf5"
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -18,12 +18,16 @@ Gem::Specification.new do |s|
   s.extensions = ["ext/hdf5/extconf.rb"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md",
+    "README.md.orig",
+    "README.rdoc",
+    "README.rdoc.orig"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "LICENSE.txt",
+    "README.md",
     "README.rdoc",
     "Rakefile",
     "VERSION",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hdf5
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Edmund Highcock
@@ -144,12 +144,18 @@ extensions:
 - ext/hdf5/extconf.rb
 extra_rdoc_files:
 - LICENSE.txt
+- README.md
+- README.md.orig
 - README.rdoc
+- README.rdoc.orig
 files:
 - ".document"
 - Gemfile
 - LICENSE.txt
+- README.md
+- README.md.orig
 - README.rdoc
+- README.rdoc.orig
 - Rakefile
 - VERSION
 - ext/hdf5/extconf.rb