mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
Scot Breitenfeld
05676d1abe
* Consolidate documentation under doc/ directory
Move user-facing guides from release_docs/ and doxygen/ into a single
doc/ root. release_docs/ now holds only release artifacts (changelogs,
history, release process, maintainer info).
- git mv release_docs/INSTALL*.md, USING_*.md, README_HPC.md,
BuildSystemNotes.md, AutotoolsToCMakeOptions.md,
HDF5_Library_2.0.0_Migration_Guide.md → doc/
- git mv doxygen/ → doc/doxygen/
- Update CMakeLists.txt: HDF5_DOXYGEN_DIR and add_subdirectory path
- Update CMakeInstallation.cmake: all install paths for moved files
- Update bin/make_vers: hardcoded doxygen/ path substitution
- Update doc/doxygen/CMakeLists.txt: EXAMPLES_DIRECTORY and comments
- Update README.md, CONTRIBUTING.md, SECURITY.md, config/README.md,
release_docs/RELEASE_PROCESS.md: links to moved files
- Update doxygen .dox files: release_docs/ URLs for moved guides
- Rewrite release_docs/README.md for narrowed scope
* Add HDF5_DOCS_DIR variable for doc/ root path
Introduce HDF5_DOCS_DIR = \${HDF5_SOURCE_DIR}/doc so that
CMakeInstallation.cmake and future callers reference the doc/
directory symbolically rather than by hardcoded path.
HDF5_DOXYGEN_DIR is now derived from HDF5_DOCS_DIR.
101 lines
2.2 KiB
Plaintext
101 lines
2.2 KiB
Plaintext
/** \page GettingStarted Getting Started with HDF5
|
|
|
|
Navigate back: \ref index "Main"
|
|
<hr>
|
|
|
|
\section sec_learn Learning HDF5
|
|
There are several resources for learning about HDF5. The HDF Group provides an on-line HDF5 tutorial,
|
|
documentation, examples, and videos. There are also tutorials provided by other organizations that are very useful for learning about HDF5.
|
|
|
|
\subsection subsec_learn_intro The HDF Group Resources
|
|
For a quick introduction to HDF5 see the following:
|
|
<table>
|
|
<tr>
|
|
<td style="background-color:#F5F5F5">
|
|
@ref IntroHDF5
|
|
</td>
|
|
<td>
|
|
A very brief introduction to HDF5 and the HDF5 programming model and APIs
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="background-color:#F5F5F5">
|
|
@ref LearnHDFView
|
|
</td>
|
|
<td>
|
|
A tutorial for learning how to use HDFView. NO programming involved!
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="background-color:#F5F5F5">
|
|
@ref LearnBasics
|
|
</td>
|
|
<td>
|
|
Step by step instructions for learning HDF5 that include programming examples
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
\subsection subsec_learn_tutor The HDF Group Tutorials & Examples
|
|
These tutorials and examples are available for learning about the HDF5 High Level APIs, tools,
|
|
Parallel HDF5, and the VDS and SWMR features:
|
|
<table>
|
|
<tr>
|
|
<td style="background-color:#F5F5F5">
|
|
[Using the High Level API](../examples/menus/high_level_menu.md)
|
|
</td>
|
|
<td>
|
|
The high-level HDF5 library includes several sets of convenience and standard-use APIs to facilitate common HDF5 operations.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="background-color:#F5F5F5">
|
|
@ref IntroParHDF5
|
|
</td>
|
|
<td>
|
|
A brief introduction to Parallel HDF5. If you are new to HDF5 please see the @ref LearnBasics topic first.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="background-color:#F5F5F5">
|
|
@ref ViewTools
|
|
</td>
|
|
<td>
|
|
\li @ref LearnHDFView
|
|
\li @ref ViewToolsCommand
|
|
\li @ref ViewToolsJPSS
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="background-color:#F5F5F5">
|
|
New Features since HDF5-1.10
|
|
</td>
|
|
<td>
|
|
\li @ref VDSTN
|
|
\li @ref SWMRTN
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="background-color:#F5F5F5">
|
|
Example Programs
|
|
</td>
|
|
<td>
|
|
@ref HDF5Examples
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="background-color:#F5F5F5">
|
|
Videos
|
|
</td>
|
|
<td>
|
|
\li <a href="https://www.youtube.com/watch?v=BAjsCldRMMc">Introduction to HDF5</a>
|
|
\li <a href="https://www.youtube.com/watch?v=qrI27pI0P1E">Parallel HDF5</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<hr>
|
|
Navigate back: \ref index "Main"
|
|
|
|
*/
|