Skip to content

Commit

Permalink
Merge pull request #206 from HDFGroup/add_docs_for_topics
Browse files Browse the repository at this point in the history
Add HDF5 Application Developer's Guide page
  • Loading branch information
bmribler authored Apr 21, 2024
2 parents 2840313 + 4280c2b commit ad03353
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions documentation/hdf5-docs/hdf5_appdev_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: HDF5 Application Developer's Guide

redirect_from:
display/HDF5/HDF5+Application+Developer's+Guide
display/HDF5/General+Topics+in+HDF5
---

# HDF5 Application Developer's Guide

## General Topics in HDF5

##\*\*\* Work-in-Progress \*\*\*

| Topic | Description |
| ----------------------------- | ------------------------------------------------------------ |
| [Environment Variables Used by HDF5]() | Environment variables that can be used when building or using HDF5 |
| [Using Compression in HDF5]() | Resources regarding compression |
| [Improving I/O Performance When Working with HDF5 Compressed Datasets](hdf5_topics/HDF5ImprovingIOPerformanceCompressedDatasets.pdf) | A description of the factors that should be considered when storing compressed data in HDF5 files and how to tune those parameters to optimize the I/O performance of an HDF5 application when working with compressed datasets (PDF) |
| [Parallel HDF5]() | Information on Parallel HDF5 |
| [Fill Value and Space Allocation Behavior]() | A table summarizing of the behavioral interactions of HDF5 fill value and storage allocation settings |
| [H5Fill Behavior]() | The library's fill value behavior for property list settings |
| [SZIP Compression in HDF5]() | A description of SZIP compression in HDF5, H5Pset_szip, terms of use and copyright notice, and references |
| [Using Identifiers](hdf5_topics/UsingIdentifiers.md) | Description of how identifiers work |
| [UTF-8 encoding in HDF5 applications](hdf5_topics/UsingUTF-8EncodinginHDF5Apps.md) | Information on using UTF-8 encoding in HDF5 applications |
| [HDF5 Dimension Scale Specification and Design Notes](hdf5_topics/H5DS_Spec.pdf) | |

<!--- In doxygen/technical notes -->
<!--- | [HDF5 Library Release Versions Numbers]() | A description of HDF5 library release version numbering | -->


<!---
Parallel HDF5 Information on Parallel HDF5
Fill Value and Space Allocation Behavior A table summarizing of the behavioral interactions of HDF5 fill value and storage allocation settings
H5Fill Behavior The library's fill value behavior for property list settings
SZIP Compression in HDF5 A description of SZIP compression in HDF5, H5Pset_szip, terms of use and copyright notice, and references
HDF5 Library Release Versions Numbers A description of HDF5 library release version numbering
Using Identifiers Description of how identifiers work
-->
<!---
### [New Features](hdf5_topics/feature.md)
### [New Features](hdf5_topics/feature.md)
### [New Features](hdf5_topics/feature.md)
-->

## [Advanced Topics in HDF5](advanced_topics_list.md)

0 comments on commit ad03353

Please sign in to comment.