Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add production rules for dataset byte streams #56

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
h5json/_version.py export-subst
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Misc.
.vscode
.DS_Store

# Byte-compiled / optimized / DLL files
__pycache__/
*.pyc
Expand All @@ -19,7 +23,7 @@ sdist/
var/
*.egg-info/
.installed.cfg
*.egg
*.egg?

# PyInstaller
# Usually these files are written by a python script from a template
Expand Down
15 changes: 15 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
version: 2

build:
os: ubuntu-20.04
tools:
python: "3.9"

python:
install:
- requirements: docs/requirements.txt

sphinx:
builder: html
configuration: docs/conf.py
fail_on_warning: true
21 changes: 10 additions & 11 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,17 @@ notifications:
email: false

python:
- "2.7"
- "3.3"
- "3.4"
- "3.5"
- "3.7"
- "3.8"
- "3.9"

install:
- sudo apt-get update -qq
- sudo apt-get install -qq libhdf5-serial-dev
- pip uninstall numpy -y
- pip install numpy>=1.10.4
- pip install h5py
- sudo apt-get update -qq
- sudo apt-get install -qq libhdf5-serial-dev
- pip uninstall numpy -y
- pip install numpy>=1.10.4
- pip install h5py

script:
- python setup.py install
- python testall.py
- python setup.py install
- python testall.py
2 changes: 1 addition & 1 deletion COPYING
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ h5serv Software Service, Libraries and Utilities
-----------------------------------------------------------------------------

h5serv (HDF5 REST Server) Service, Libraries and Utilities
Copyright 2014-2016 by The HDF Group.
Copyright 2014-2017 by The HDF Group.

All rights reserved.

Expand Down
16 changes: 9 additions & 7 deletions Docker/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
## Dockerfile Image for hdf5-json Python Package
# Docker Images for HDF5/JSON

## hdf5-json Python Package

Ingredients:

## Ingredients:

* Python 3.5
* HDF5 1.8.16
* h5py 2.6.0
* PyTables 3.2.2
* hdf5-json package

## Instructions
### Instructions

Run with the docker '-it' flag, and the data volume to use.
Build Docker image from [`Dockerfile`](./Dockerfile). Run with the docker `-it` flag, and a data volume to use.

Example:

```$docker run -it -v <mydata>:/data hdfgroup/hdf5-json /bin/bash```
$ docker run -it -v <mydata>:/data hdfgroup/hdf5-json /bin/bash

Where "mydata" is the path to a folder on the host that (presumably) holds some HDF5
files to use with hdf5-json.

Also sample HDF5 and JSON files can be found on /usr/local/src/hdf5-json/data/.

## See Also:
Expand Down
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include versioneer.py
include h5json/_version.py
63 changes: 18 additions & 45 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,66 +1,39 @@
hdf5-json
=========
h5json
======

.. image:: https://travis-ci.org/HDFGroup/hdf5-json.svg?branch=develop
:target: https://travis-ci.org/HDFGroup/hdf5-json
:target: https://travis-ci.org/HDFGroup/hdf5-json

Specification and tools for representing HDF5 in JSON
.. image:: https://readthedocs.org/projects/hdf5-json/badge/?version=latest
:target: https://hdf5-json.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

Specification and tools for representing HDF5 in JSON.


Introduction
------------
This repository contains a specification, library, and utilities for describing HDF5 content in JSON.
The utilities can be used to convert any HDF5 file to JSON or from a JSON file (using the convention
This repository contains a specification, library, and utilities for describing HDF5 content in JSON.
The utilities can be used to convert any HDF5 file to JSON or from a JSON file (using the convention
described here to HDF5).

The library is useful for any Python application that needs to translate between HDF5 objects and JSON
serializations. In addition to the utilities provided in this repository, the library is used by HDF
Server (a RESTful web service for HDF5), and HDF Product Designer (an application for creating product
designs).

This respository also include utilities to generate code in Fortran or Python based on a JSON file.
The library is useful for any Python application that needs to translate between HDF5 objects and JSON
serializations. In addition to the utilities provided in this repository, the library is used by `HDF
Server <https://www.hdfgroup.org/solutions/highly-scalable-data-service-hsds/>`_ (a RESTful web service for HDF5), and `HDF Product Designer <https://wiki.earthdata.nasa.gov/display/HPD/HDF+Product+Designer>`_ (an application for creating product
designs).

See :doc:`Utilities` for a description of the included utilties.

Websites
--------

* Main website: http://www.hdfgroup.org
* Source code: https://github.com/HDFGroup/hdf5-json
* Mailing list: hdf-forum@lists.hdfgroup.org <hdf-forum@lists.hdfgroup.org>
* Documentation: http://hdf5-json.readthedocs.org

Related Projects
----------------
* HDF Server: https://www.hdfgroup.org/projects/hdfserver/
* Product Designer: https://wiki.earthdata.nasa.gov/display/HPD/HDF+Product+Designer

Installing
-----------

Via pip::

pip install h5json

From a release tarball or Git checkout::
* HDF Forum: https://forum.hdfgroup.org/c/hsds
* Documentation: https://hdf5-json.readthedocs.org

python setup.py install
python testall.py # optional

The hd5tojson.py and jsontoh5.py convertors will be added to the path.
See docs/Installation.rst for step by step instructions.


Uninstalling
------------

Just remove the install directory and all contents to uninstall.


Reporting bugs (and general feedback)
-------------------------------------

Create new issues at http://github.com/HDFGroup/hdf5-json/issues for any problems you find.

For general questions/feedback, please use the list (hdf-forum@lists.hdfgroup.org).
Create new issues at http://github.com/HDFGroup/hdf5-json/issues for any problems you find.

For general questions/feedback, please post on the `HDF Forum <https://forum.hdfgroup.org/c/hsds>`_.
Binary file added data/hdf5/scalar_array_dset.h5
Binary file not shown.
Loading