Repository Public License
1# HDF523| | |4|---|---|5| Name | HDF5 (Hierarchical Data Format 5) — C library and high-level library (dimension scales) |6| Version | 2.2.0 |7| Source | https://github.com/HDFGroup/hdf5/releases/download/2.2.0/hdf5-2.2.0.tar.gz |8| SHA-256 of the archive | `1a1ab8209b35586fbc1aa279ba76d102130b95badcb20ca329587219112d8c16` |9| Project | https://www.hdfgroup.org/solutions/hdf5/ — https://github.com/HDFGroup/hdf5 |10| License | BSD 3-Clause (file `LICENSE` of the source archive), with the additional notices reproduced below |11| Copyright | Copyright 2006 by The HDF Group. Copyright 1998-2006 by The Board of Trustees of the University of Illinois. |1213## Why it is bundled1415HDF5 is the container of `.h5` / `.hdf5` files and of NetCDF-4 files. The format is too large to re-implement16(B-trees, heaps, chunk indexes, filters, datatype conversion); the reference C library is the only complete reader17and writer. The scientific engine uses it for inspection, hyperslab reads, flattening to tables and18HDF5 ↔ NetCDF-4 conversions. NetCDF classic files do **not** go through it: the engine has its own reader and19writer for them, and no netCDF library is bundled.2021## How it is built and linked2223`build.sh` downloads the pinned archive, checks its SHA-256 and builds with CMake for arm64 / macOS 15.024(`MACOSX_DEPLOYMENT_TARGET=15.0`, Release, static):2526- C library and high-level library only: no C++, Fortran or Java bindings, no command-line tools, tests or examples;27- no MPI (parallel), no thread-safe or concurrency mode (the engine serialises every call behind one lock);28- deflate through the zlib of the macOS SDK (Homebrew prefixes are excluded from the search); **no szip / libaec**29 (datasets compressed with szip are reported as unreadable); no bundled filter plug-ins;30- no remote or exotic file drivers: ROS3 (S3), HDFS, mirror and direct drivers are off;31- the default plug-in directory compiled into the library is `/var/empty/orix-convert-hdf5-plugins-disabled`,32 which cannot exist.3334`libhdf5.a` and `libhdf5_hl.a` are merged with `libtool -static` into `libCHDF5.a`, wrapped with the public headers35into `CHDF5.xcframework`, and its module map is moved by `../normalize-xcframework.sh` like every other bundled36library. `Packages/EngineScientific/Package.swift` consumes it as a SwiftPM `binaryTarget` (module `CHDF5`); the C37target `CHDF5Shim` supplies what Swift cannot import (macro identifiers, callbacks). The code is statically linked;38nothing is loaded at run time and nothing is looked up on the user's Mac.3940Run-time hardening done by the shim before the first use of the library (`orix_h5_init`):4142- `HDF5_PLUGIN_PRELOAD` is set to `::` (plug-in loading disabled), `H5PLset_loading_state(0)` is called and the43 plug-in search table is emptied, so a file cannot make the library load code from disk;44- `HDF5_VOL_CONNECTOR`, `HDF5_DRIVER`, `HDF5_DRIVER_CONFIG` and `HDF5_USE_FILE_LOCKING` are removed from the45 environment;46- the library's external-link class is replaced by one whose traversal always fails, and every access property47 list used on a source file carries a callback refusing external-link traversal: a link to another file is listed48 with its target and never followed;49- automatic error printing is turned off; errors are read from the error stack and turned into Swift errors.5051Build-time tools used: `cmake` (Homebrew, already present on the build machine), `make`, `libtool`, `xcodebuild`.52None of them is needed at run time.5354Sizes measured on 2026-11-21: source archive 42 131 403 bytes; `libCHDF5.a` 9 048 728 bytes;55`CHDF5.xcframework` 11 040 kB on disk (static archive + 66 public headers). Only the object code the engine56references is linked into the application.5758The source code is not modified. `src/`, `work/`, `prefix/` and `CHDF5.xcframework/` are build products and are not59committed.6061## Obligations6263BSD 3-Clause: the copyright notice, the list of conditions and the disclaimer must be reproduced in the64documentation or other materials provided with the binary distribution, and the names of The HDF Group, of the65University or of contributors may not be used to endorse the product. The UC LLNL statement below says of itself66that it "must be retained in any redistribution of source code, binaries, documentation, and/or accompanying67materials". The application's acknowledgements must therefore include the whole text below.6869```70Copyright Notice and License Terms for71HDF5 (Hierarchical Data Format 5) Software Library and Utilities72-----------------------------------------------------------------------------7374HDF5 (Hierarchical Data Format 5) Software Library and Utilities75Copyright 2006 by The HDF Group.7677NCSA HDF5 (Hierarchical Data Format 5) Software Library and Utilities78Copyright 1998-2006 by The Board of Trustees of the University of Illinois.7980All rights reserved.8182This software library and utilities is covered by the 3-clause BSD License.8384Redistribution and use in source and binary forms, with or without85modification, are permitted for any purpose (including commercial purposes)86provided that the following conditions are met:87881. Redistributions of source code must retain the above copyright notice,89 this list of conditions, and the following disclaimer.90912. Redistributions in binary form must reproduce the above copyright notice,92 this list of conditions, and the following disclaimer in the documentation93 and/or materials provided with the distribution.94953. Neither the name of The HDF Group, the name of the University, nor the96 name of any Contributor may be used to endorse or promote products derived97 from this software without specific prior written permission from98 The HDF Group, the University, or the Contributor, respectively.99100DISCLAIMER:101THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS102“AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,103THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE104ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE105FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL106DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS107OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER108CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR109TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS110SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.111112For further details, please refer to the full license text available113at https://opensource.org/licenses/bsd-3-clause114115You are under no obligation whatsoever to provide any bug fixes, patches, or116upgrades to the features, functionality or performance of the source code117("Enhancements") to anyone; however, if you choose to make your Enhancements118available either publicly, or directly to The HDF Group, without imposing a119separate written license agreement for such Enhancements, then you hereby120grant the following license: a non-exclusive, royalty-free perpetual license121to install, use, modify, prepare derivative works, incorporate into other122computer software, distribute, and sublicense such enhancements or derivative123works thereof, in binary and source code form.124125-----------------------------------------------------------------------------126-----------------------------------------------------------------------------127128Contributors: National Center for Supercomputing Applications (NCSA) at129the University of Illinois, Fortner Software, Unidata Program Center130(netCDF), The Independent JPEG Group (JPEG), Jean-loup Gailly and Mark Adler131(gzip), and Digital Equipment Corporation (DEC).132133-----------------------------------------------------------------------------134135Portions of HDF5 were developed with support from the Lawrence Berkeley136National Laboratory (LBNL) and the United States Department of Energy137under Prime Contract No. DE-AC02-05CH11231.138139-----------------------------------------------------------------------------140141Portions of HDF5 were developed with support from Lawrence Livermore142National Laboratory and the United States Department of Energy under143Prime Contract No. DE-AC52-07NA27344.144145-----------------------------------------------------------------------------146147Portions of HDF5 were developed with support from the University of148California, Lawrence Livermore National Laboratory (UC LLNL).149The following statement applies to those portions of the product and must150be retained in any redistribution of source code, binaries, documentation,151and/or accompanying materials:152153 This work was partially produced at the University of California,154 Lawrence Livermore National Laboratory (UC LLNL) under contract155 no. W-7405-ENG-48 (Contract 48) between the U.S. Department of Energy156 (DOE) and The Regents of the University of California (University)157 for the operation of UC LLNL.158159 DISCLAIMER:160 THIS WORK WAS PREPARED AS AN ACCOUNT OF WORK SPONSORED BY AN AGENCY OF161 THE UNITED STATES GOVERNMENT. NEITHER THE UNITED STATES GOVERNMENT NOR162 THE UNIVERSITY OF CALIFORNIA NOR ANY OF THEIR EMPLOYEES, MAKES ANY163 WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY OR RESPONSIBILITY164 FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF ANY INFORMATION,165 APPARATUS, PRODUCT, OR PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE166 WOULD NOT INFRINGE PRIVATELY- OWNED RIGHTS. REFERENCE HEREIN TO ANY167 SPECIFIC COMMERCIAL PRODUCTS, PROCESS, OR SERVICE BY TRADE NAME,168 TRADEMARK, MANUFACTURER, OR OTHERWISE, DOES NOT NECESSARILY CONSTITUTE169 OR IMPLY ITS ENDORSEMENT, RECOMMENDATION, OR FAVORING BY THE UNITED170 STATES GOVERNMENT OR THE UNIVERSITY OF CALIFORNIA. THE VIEWS AND171 OPINIONS OF AUTHORS EXPRESSED HEREIN DO NOT NECESSARILY STATE OR REFLECT172 THOSE OF THE UNITED STATES GOVERNMENT OR THE UNIVERSITY OF CALIFORNIA,173 AND SHALL NOT BE USED FOR ADVERTISING OR PRODUCT ENDORSEMENT PURPOSES.174175-----------------------------------------------------------------------------176177Portions of HDF5 were developed with support from the National Science178Foundation under Federal Award No. 2534078.179180-----------------------------------------------------------------------------181```182