Skip to content

Commit

Permalink
Update doxygen Learn Basics / example refs. Add Reference sections (H…
Browse files Browse the repository at this point in the history 
…DFGroup#4640)
  • Loading branch information
@byrnHDF
byrnHDF authored Jul 16, 2024
1 parent e6e098b commit e716059
Show file tree
Hide file tree
Showing 30 changed files with 788 additions and 115 deletions.
6 changes: 3 additions & 3 deletions .../TUTR/H5_CreateGroupAbsoluteRelative.java → ...TUTR/HDF5GroupAbsoluteRelativeCreate.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
import hdf.hdf5lib.H5;
import hdf.hdf5lib.HDF5Constants;

public class H5_CreateGroupAbsoluteRelative {
private static String FILENAME = "H5_CreateGroupAbsoluteRelative.h5";
public class HDF5GroupAbsoluteRelativeCreate {
private static String FILENAME = "HDF5GroupAbsoluteRelativeCreate.h5";
private static String GROUPNAME = "MyGroup";
private static String GROUPNAME_A = "GroupA";
private static String GROUPNAME_B = "GroupB";
Expand Down Expand Up @@ -109,6 +109,6 @@ private static void CreateGroupAbsoluteAndRelative()

public static void main(String[] args)
{
H5_CreateGroupAbsoluteRelative.CreateGroupAbsoluteAndRelative();
HDF5GroupAbsoluteRelativeCreate.CreateGroupAbsoluteAndRelative();
}
}
1 change: 1 addition & 0 deletions HDF5Examples/JAVA/TUTR/Java_sourcefiles.cmake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ set (HDF_JAVA_EXAMPLES
HDF5DatasetRead.java
HDF5GroupDatasetCreate.java
HDF5SubsetSelect.java
HDF5GroupAbsoluteRelativeCreate.java
)
if (H5_LIBVER_DIR EQUAL 110)
set (HDF_JAVA_EXAMPLES ${HDF_JAVA_EXAMPLES}
Expand Down
Empty file added HDF5Examples/JAVA/TUTR/tfiles/110/HDF5GroupAbsoluteRelativeCreate.txt
View file
Empty file.
10 changes: 9 additions & 1 deletion doxygen/aliases
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,26 @@ ALIASES += THG="The HDF Group"
################################################################################
# Default URLs (Note that md files do not use any aliases)
################################################################################
# Default URL for HDF Group Files
ALIASES += HDFURL="docs.hdfgroup.org/hdf5"
# URL for archived files
ALIASES += ARCURL="docs.hdfgroup.org/archive/support/HDF5/doc"
# URL for RFCs
ALIASES += RFCURL="docs.hdfgroup.org/hdf5/rfc"
# URL for documentation
ALIASES += DSPURL="portal.hdfgroup.org/display/HDF5"
ALIASES += DOCURL="portal.hdfgroup.org/documentation/hdf5-docs"
# URL for downloads
ALIASES += DWNURL="portal.hdfgroup.org/downloads"
ALIASES += AEXURL="support.hdfgroup.org/ftp/HDF5/examples"
# doxygen subdir (develop, v1_14)
ALIASES += DOXURL="hdfgroup.github.io/hdf5/develop"
#branch name (develop, hdf5_1_14)
ALIASES += SRCURL="github.com/HDFGroup/hdf5/blob/develop"

#Other projects that contribute to HDF5
ALIASES += PRJURL="\HDFURL/projects"
ALIASES += HVURL="github.com/HDFGroup/hdfview/blob/master"
ALIASES += PLURL="github.com/HDFGroup/hdf5_plugins/blob/master"
################################################################################
# Styling
################################################################################
Expand Down
24 changes: 16 additions & 8 deletions doxygen/dox/IntroHDF5.dox
View file
Original file line number Diff line number Diff line change
Expand Up @@ -298,19 +298,27 @@ hsize_t is used for dimensions
Language specific files must be included in applications:
<ul>
<li>
Python: Add <code>"import h5py / import numpy"</code>
<strong>Python</strong>:<br />
<code>
import h5py<br />
import numpy
</code>
</li>
<li>
C: Add <code>"#include hdf5.h"</code>
<strong>C</strong>:<br />
<code>"#include hdf5.h"</code>
</li>
<li>
FORTRAN: Add <code>"USE HDF5"</code> and call h5open_f and h5close_f to initialize and close the HDF5 FORTRAN interface
<strong>FORTRAN</strong>:<br />
<code>USE HDF5</code><br />
and call h5open_f and h5close_f to initialize and close the HDF5 FORTRAN interface
</li>
<li>
Java: Add <code>"import hdf.hdf5lib.H5;
import hdf.hdf5lib.HDF5Constants;"</code>
</li>
</ul>
<strong>Java</strong>:<br />
<code>
import hdf.hdf5lib.H5;<br />
import hdf.hdf5lib.HDF5Constants;
</code>
</li>
</ul>

Expand Down Expand Up @@ -608,7 +616,7 @@ on the <a href="http://hdfeos.org/">HDF-EOS Tools and Information Center</a> pag
\section secHDF5Examples Examples
\li \ref LBExamples
\li \ref ExAPI
\li <a href="https://github.com/HDFGroup/hdf5/tree/develop/examples">Examples in the Source Code</a>
\li <a href="https://github.com/HDFGroup/hdf5/tree/develop/HDF5Examples">Examples in the Source Code</a>
\li <a href="https://\DSPURL/Other+Examples">Other Examples</a>

\section secHDF5ExamplesCompile How To Compile
Expand Down
18 changes: 9 additions & 9 deletions doxygen/dox/LearnBasics.dox
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Navigate back: \ref index "Main" / \ref GettingStarted
Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
<hr>

\section secLBExamples
\section secLBExamples HDF5 Examples
These examples are used in the \ref LearnBasics topic. See \ref LBCompiling for details on compiling them.
PLEASE NOTE that the example programs are listed in the order they are expected to be run. Some example
programs use files created in earlier examples.
Expand All @@ -59,63 +59,63 @@ These examples (C, C++, Fortran, Java, Python) are provided in the HDF5 source c
<tr>
<td>Create a file
</td>
<td>C Fortran C++ <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5FileCreateFile.java">Java</a> Python
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtgrp.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtgrp.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtgrp.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5FileCreate.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtgrp.py">Python</a>
</td>
<td>
</td>
</tr>
<tr>
<td>Create a dataset
</td>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtdat.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtdat.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtdat.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/H5_CreateDataset.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtdat.py">Python</a>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtdat.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtdat.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtdat.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5DatasetCreate.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtdat.py">Python</a>
</td>
<td>
</td>
</tr>
<tr>
<td>Read and write to a dataset
</td>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_rdwt.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_rdwt.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_rdwt.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/H5_ReadWrite.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_rdwt.py">Python</a>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_rdwt.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_rdwt.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_rdwt.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5DatasetRead.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_rdwt.py">Python</a>
</td>
<td>
</td>
</tr>
<tr>
<td>Create an attribute
</td>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtatt.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtatt.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtatt.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/H5_CreateAttribute.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtatt.py">Python</a>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtatt.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtatt.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtatt.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5AttributeCreate.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtatt.py">Python</a>
</td>
<td>
</td>
</tr>
<tr>
<td>Create a group
</td>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtgrp.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtgrp.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtgrp.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/H5_CreateGroup.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtgrp.py">Python</a>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtgrp.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtgrp.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtgrp.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5GroupCreate.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtgrp.py">Python</a>
</td>
<td>
</td>
</tr>
<tr>
<td>Create groups in a file using absolute and relative paths
</td>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtgrpar.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtgrpar.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtgrpar.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/H5_CreateGroupAbsoluteRelative.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtgrpar.py">Python</a>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtgrpar.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtgrpar.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtgrpar.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5GroupAbsoluteRelativeCreate.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtgrpar.py">Python</a>
</td>
<td>
</td>
</tr>
<tr>
<td>Create datasets in a group
</td>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtgrpd.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtgrpd.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtgrpd.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/H5_CreateGroupDataset.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtgrpd.py">Python</a>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_crtgrpd.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_crtgrpd.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_crtgrpd.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5GroupDatasetCreate.java">Java</a> <a href="https://\SRCURL/HDF5Examples/PYTHON/h5_crtgrpd.py">Python</a>
</td>
<td>
</td>
</tr>
<tr>
<td>Create a file and dataset and select/read a subset from the dataset
</td>
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_subset.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_subset.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_subset.cpp">C++</a> Java Python
<td><a href="https://\SRCURL/HDF5Examples/C/TUTR/h5_subset.c">C</a> <a href="https://\SRCURL/HDF5Examples/FORTRAN/TUTR/h5_subset.f90">Fortran</a> <a href="https://\SRCURL/HDF5Examples/CXX/TUTR/h5tutr_subset.cpp">C++</a> <a href="https://\SRCURL/HDF5Examples/JAVA/TUTR/HDF5SubsetSelect.java">Java</a> Python
</td>
<td>Also see examples to Write by row (and column) below.
</td>
Expand Down
Loading

0 comments on commit e716059

Please sign in to comment.