HDF5 Documentation

50 %
50 %
Information about HDF5 Documentation
Technology

Published on February 18, 2014

Author: HDFEOS

Source: slideshare.net

Description

This presentation is intended to familiarize current HDF users and those considering adopting HDF with the range of technical documentation that we provide.

We will discuss documents that are shipped with the product and those that are available from the HDF websites. We will touch on user documentation, supporting technical documents, RFCs and design documents, other papers and presentations, etc.

HDF5 Documentation An overview of the HDF5 document set Frank Baker Technical Writer The HDF Group 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD (217) 244-7223 fbaker@hdfgroup. org 1

Objectives •  To make sure people are aware of various elements of HDF documentation, particularly HDF5 •  To encourage feedback •  How can the docs better serve you? •  Let us know when you see errors. help@hdfgroup.org •  We’ll come back to this. 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 2

HDF Documentation •  HDF4 •  C Library APIs and Fortran wrappers •  Tools -- Data management and viewing •  HDF5 •  C Library APIs and High-level APIs •  Fortran, C++ and Java wrappers and subroutines •  Tools -- Data management and viewing Software configuration, build and install •  HDF4 to HDF5 Conversion Library •  HDF Java products •  HDFview 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 3

HDF5 Documentation for All Users Users with all types of needs can find relevant information: •  Data users •  Application Developers •  Library and driver developers 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 4

HDF5 Data Users To examine data and browse HDF5 files: •  HDF5 Tools •  Command-line utilities •  Browsers •  HDFview offers limited editing features •  Glossary 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 5

HDF5 Application Developers Writing applications for your own data and for large projects: •  •  •  •  HDF5 Tutorials Introduction to HDF5 HDF5 User’s Guide HDF5 Reference Manual •  HDF5 Tools •  Example programs and HDF5 source code •  FAQs •  Glossary 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 6

HDF5 Application Developers (2) As projects progress, programs endure, and applications become more complex: •  HDF5 Application Developer’s Guide •  Software Changes from Release to Release •  HDF5 File Format Specification 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 7

HDF5 Library and I/O Driver Developers Developing I/O drivers and working inside the HDF5 Library: •  HDF5 Technical Notes for Library and Driver Developers 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 8

Non-C Interfaces to HDF5 HDF5 Library is written in C. But Fortran, C++, Java interfaces are also available. (And C# is on the way.) Where would one find that documentation? 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 9

Fortran, C++ and Java Interfaces All linked from index page: •  Under “HDF5 and Foreign Languages” •  http://hdfgroup.org/HDF5/doc/ Fortran •  Embedded with C APIs in HDF5 Reference Manual •  http://hdfgroup.org/HDF5/doc/RM/ C++ •  Separate reference manual http://hdfgroup.org/HDF5/doc/ cpplus_RM/index.html Java •  Separate subsite •  http://hdfgroup.org/hdf-java-html/ 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 10

Additional HDF5 Documentation, Features •  Pre-release snapshots •  Routinely-provided snapshots at doc_dev_snapshot/ The current state of a development or release branch http://hdfgroup.com/HDF5/doc_dev_snapshot/ •  1.8 pre-release series, alphas and betas http://hdfgroup.org/HDF5/doc_1.8pre/ •  Requests for Comment (RFCs), generally with substantial design material User input is critical! Participation leads to involvement! Let us know if you’re interested! 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 11

A Walking Tour 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 12

Native and Distribution Formats •  Generally HTML •  HDF5 Reference Manual and HDF5 User’s Guide •  Printable “book style” PDF versions generated at major releases •  Core documents set designed to be served from a website or viewed from a local installation •  All docs except HDF5 Tutorial •  Tarball available for local or behind-the-firewall installation 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 13

Credit Where Credit Is Due Developers participate heavily in creating and maintaining the documentation •  Core library developers routinely provide •  Initial reference manual entries •  Major chunks of text and examples for the user guides •  RFCs, from which other documentation is often built •  Entire ADGuide and TechNotes documents •  Binh-Minh Ribler: C++ docs, with doxygen •  Peter Cao: HDFview and other Java products, with Java Doc •  And everybody reviews! 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 14

Your feedback matters! •  Let us know when you find any problem •  Errors •  Incomplete information •  Areas where more explanation (or the right, targeted explanation) would have helped you avoid a problem or otherwise saved you time •  help@hdfgroup.org 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 15

Your feedback matters! •  Beyond that… •  Suggestions? •  What gives you the most difficulty? •  What is most helpful? •  What’s missing? 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 16

The End This report is based upon work supported in part by a Cooperative Agreement with NASA under NASA NNG05GC60A. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Aeronautics and Space Administration. 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 17

Contact Information Frank Baker Senior Technical Writer The HDF Group 1901 South First Street Champaign, IL 61820 USA (217) 244-7223 fbaker@hdfgroup.org 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 18

URLs HDF5 Tools: hdfgroup.org/HDF5/doc/Tools.html HDF5 Docs Index: hdfgroup.org/HDF5/doc/ <== Ties it all together. Pre-releases and Snapshots: hdfgroup.org/HDF5/doc_1.8pre/ hdfgroup.org/HDF5/doc_dev_snapshot/ RFCs: hdfgroup.org/RFC/ HDF5 Tutorial: hdfgroup.org/HDF5/Tutor/index.html Printable Documents: hdfgroup.org/HDF5/doc/PSandPDF/ Bug Reports and Enhancement Requests: help@hdfgroup.org FAQs: hdfgroup.org/HDF5-FAQ.html 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 19

And back to your feedback… •  Beyond that… •  Suggestions? •  What gives you the most difficulty? •  What is most helpful? •  What’s missing? 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 20

index.html -- An Alternative Style 2/18/14 HDF and HDF-EOS Workshop X, Landover, MD 21

Add a comment

Related presentations

Presentación que realice en el Evento Nacional de Gobierno Abierto, realizado los ...

In this presentation we will describe our experience developing with a highly dyna...

Presentation to the LITA Forum 7th November 2014 Albuquerque, NM

Un recorrido por los cambios que nos generará el wearabletech en el futuro

Um paralelo entre as novidades & mercado em Wearable Computing e Tecnologias Assis...

Microsoft finally joins the smartwatch and fitness tracker game by introducing the...

Related pages

HDF5 Documentation - The HDF Group - Information, Support ...

HDF5 Tools: HDFView Browser and editor Excellent choice for a “first look” All HDF5 Tools Command-line tools, conversion utilities, and ...
Read more

HDF Group - HDF5 - Hierarchical Data Format

WELCOME to the HDF5 Home Page! Current Releases: HDF5-1.8.17, HDF5-1.10.0 HDF5 is a data model, library, and file format for storing and managing data.
Read more

HDF5 for Python — h5py 2.6.0 documentation

HDF5 for Python¶ The h5py package is a Pythonic interface to the HDF5 binary data format. HDF5 lets you store huge amounts of numerical data, and easily ...
Read more

HDF5 Tools Documentation

HDF5 Tools Documentation: HDFview Browser and editor Excellent choice for a “first look” HDF5 Utilities Command-line tools, conversion utilites ...
Read more

Importing HDF5 Files - MATLAB & Simulink - MathWorks ...

Search MATLAB Documentation. Documentation. Support; MathWorks; Search All Support Resources. Support. Documentation; ... Importing HDF5 Files; On this ...
Read more

HDF5 Tutorial — HDF5 Tutorial 1.0 documentation

HDF5 Tutorial¶ This tutorial is an introduction to HDF5. It shows how to read existing HDF5 files, and how to create and modify your own files.
Read more

HDF5 Node Interface Documentation : HDF5 Docs

Because this project has native code look at Install & Setup for the details. To start a new h5 file and populate it with groups and data: bash node ...
Read more

Exporting to HDF5 Files - MATLAB & Simulink

Exporting to HDF5 Files. Overview. Hierarchical Data ... Refer to the HDF5 documentation to see which constants can be used with a particular function ...
Read more

HDF5 Files - MATLAB & Simulink - MathWorks Deutschland

Search MATLAB Documentation. ... High-level access functions make it easy to read a data set from an HDF5 file or write a ... and write HDF5 files;
Read more