Skip to content

Commit

Permalink
Fix various mistakes in doxygen docs (HDFGroup#4541)
Browse files Browse the repository at this point in the history
* Fix a dead link and example file names

* Add the missing content of a section
  • Loading branch information
bmribler authored Jun 3, 2024
1 parent 62274e4 commit c8371ca
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 5 deletions.
15 changes: 10 additions & 5 deletions doxygen/dox/IntroParHDF5.dox
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ The following shows the Parallel HDF5 implementation layers:
This tutorial assumes that you are somewhat familiar with parallel programming with MPI (Message Passing Interface).

If you are not familiar with parallel programming, here is a tutorial that may be of interest:
<a href="http://www.nersc.gov/users/training/online-tutorials/introduction-to-scientific-i-o/?show_all=1">Tutorial on HDF5 I/O tuning at NERSC</a>
<a href="https://\DOCURL/hdf5_topics/2016_NERSC_Introduction_to_Scientific_IO.pdf">Tutorial on HDF5 I/O tuning at NERSC</a>.
(NOTE: As of 2024, the specific systems described in this tutorial are outdated.)

Some of the terms that you must understand in this tutorial are:
<ul>
Expand Down Expand Up @@ -150,8 +151,10 @@ Following is example code for creating an access template in HDF5:
\endcode

The following example programs create an HDF5 file using Parallel HDF5:
<a href="https://\SRCURL/HDF5Examples/C/H5PAR/ph5_file_create.c">C: file_create.c</a>
<a href="https://\SRCURL/HDF5Examples/FORTRAN/H5PAR/ph5_f90_file_create.F90">F90: file_create.F90</a>

<a href="https://\SRCURL/HDF5Examples/C/H5PAR/ph5_file_create.c">C: ph5_file_create.c</a>

<a href="https://\SRCURL/HDF5Examples/FORTRAN/H5PAR/ph5_f90_file_create.F90">F90: ph5_f90_file_create.F90</a>


\subsection subsec_pintro_create_dset Creating and Accessing a Dataset with PHDF5
Expand Down Expand Up @@ -231,8 +234,10 @@ The following code demonstrates a collective write using Parallel HDF5:
\endcode

The following example programs create an HDF5 dataset using Parallel HDF5:
<a href="https://\SRCURL/HDF5Examples/C/H5PAR/ph5_dataset.c">C: dataset.c</a>
<a href="https://\SRCURL/HDF5Examples/FORTRAN/H5PAR/ph5_f90_dataset.F90">F90: dataset.F90</a>

<a href="https://\SRCURL/HDF5Examples/C/H5PAR/ph5_dataset.c">C: ph5_dataset.c</a>

<a href="https://\SRCURL/HDF5Examples/FORTRAN/H5PAR/ph5_f90_dataset.F90">F90: ph5_f90_dataset.F90</a>


\subsubsection subsec_pintro_hyperslabs Hyperslabs
Expand Down
13 changes: 13 additions & 0 deletions doxygen/dox/LearnBasics3.dox
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,19 @@ Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
<hr>

\section secLBDsetLayoutDesc Description of a Dataset
The Creating a Dataset tutorial topic defines a dataset as a multidimensional array of data elements together with supporting metadata, where:

\li The array of elements consists of the raw data values that a user wishes to store in HDF5.
\li The supporting metadata describes that data. The metadata is stored in the dataset (object) header of a dataset.

Datatype, dataspace, attribute, and storage layout information were introduced as part of the metadata associated with a dataset:
<table>
<tr>
<td>
\image html tutr-lodset.png
</td>
</tr>
</table>

\section secLBDsetLayout Dataset Storage Layout
The storage information, or storage layout, defines how the raw data values in the dataset are
Expand Down
Binary file added doxygen/img/tutr-lodset.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c8371ca

Please sign in to comment.