Skip to content

Commit e97046f

Browse files
committed
updated readme
1 parent 51e0416 commit e97046f

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,18 @@
1-
# hdf-rest-api
1+
# HDF REST API
2+
3+
4+
The HDF REST API is an interface to HDF5 data stored on network-based architectures. The HDF REST API has provisions to support CRUD (create, read, update and delete) operations on the full spectrum of HDF5 objects including: groups, links, datasets, attributes, and committed data types. See <https://support.hdfgroup.org/pubs/papers/RESTful_HDF5.pdf> for more information on the RESTful HDF5 interface.
5+
6+
As a REST-based API, implementations can be developed in a variety of languages, such as JavaScript, Python, C, and other common languages. Some services which implement the HDF REST API are:
7+
8+
* HDF Kita: <https://www.hdfgroup.org/hdf-kita>
9+
* HSDS: <https://github.com/HDFGroup/hsds>
10+
* H5serv: <https://github.com/HDFGroup/h5serv>
11+
12+
Not all implementations support all the REST operations documented here. When a specific operation is not supported in one of the above implementations, it will be noted.
13+
14+
There are also various packages and libraries that utilize the REST API as a client. These include:
15+
16+
* Python SDK - h5pyd: <https://github.com/HDFGroup/h5pyd>
17+
* C/Fortran HDF5 REST VOL: <https://bitbucket.hdfgroup.org/users/jhenderson/repos/rest-vol/browse>
18+
* R SDK - restfulSE: <https://github.com/vjcitn/restfulSE>

0 commit comments

Comments
 (0)