Skip to content

Commit f632894

Browse files
committed
added diagram to README
1 parent e97046f commit f632894

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# HDF REST API
22

3+
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 background on the design principles that guided the development of the RESTful HDF5 interface.
34

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+
This repository provides documentation on what operations are supported by the HDF REST API and some guidelines as to how to effectively use these.
56

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+
As a REST-based API, different servers can be developed that support the HDF REST API. Some services which have implemented the HDF REST API are:
78

89
* HDF Kita: <https://www.hdfgroup.org/hdf-kita>
910
* HSDS: <https://github.com/HDFGroup/hsds>
@@ -16,3 +17,9 @@ There are also various packages and libraries that utilize the REST API as a cli
1617
* Python SDK - h5pyd: <https://github.com/HDFGroup/h5pyd>
1718
* C/Fortran HDF5 REST VOL: <https://bitbucket.hdfgroup.org/users/jhenderson/repos/rest-vol/browse>
1819
* R SDK - restfulSE: <https://github.com/vjcitn/restfulSE>
20+
21+
22+
23+
The following diagram illustrates the various resources and operations of the HDF REST API:
24+
25+
![RESTful HDF Diagram](/Users/jreadey/hdfcloud/hdf-rest-api/RESTful_HDF5.png)

0 commit comments

Comments
 (0)