https://github.com/hdfgroup/arch-doc
Home of the HDF5 Library Architecture Overview
https://github.com/hdfgroup/arch-doc
Last synced: 3 months ago
JSON representation
Home of the HDF5 Library Architecture Overview
- Host: GitHub
- URL: https://github.com/hdfgroup/arch-doc
- Owner: HDFGroup
- Created: 2023-12-14T20:39:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T22:10:53.000Z (over 2 years ago)
- Last Synced: 2025-04-06T12:45:55.779Z (about 1 year ago)
- Language: TeX
- Size: 5.06 MB
- Stars: 0
- Watchers: 6
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Support: support/glossary.tex
Awesome Lists containing this project
README
## Project Philosophy
> I don't mean a bricks and mortar architect. I mean an architect as used in the words _architect of foreign policy_. I mean architect as in the creating of systemic, structural, and orderly principles to make something work -- the thoughtful making of either artifact, or idea, or policy that informs because it is clear. I use the word information in its truest sense. Most of the word information contains the word _inform_, so I call things information only if they inform me, not if they are just collections of data, of stuff. (Saul Wurman)
> -- Saul Wurman
## Overview
This document, *An Overview of the HDF5 Library Architecture*, aims to provide a thorough understanding of the inner workings of the HDF5 library by delving into its underlying principles. It covers the systemic, structural, and orderly aspects that make the library function in a clear and informative manner. By going through this document, one can gain insights into the library's architecture and how to use it efficiently. Additionally, it will provide an overview of the various approaches used to simplify the understanding of the operations of the HDF5 library.
## Documentation
This document is being worked on in Overleaf. This repository and the Overleaf manuscript are regularly synced, ensuring that any changes made to the document in Overleaf are reflected in this repository and vice-versa.
The most recent version of the manuscript in PDF format can be found at the top level of the repository.
## Contributing
We want to invite and encourage individuals to contribute to our documentation project. We are open to receiving any contributions or suggestions to help improve or add to our existing topics, whether a minor correction or a new topic addition.
The recommended approach for contributing to the document is by using pull requests (PR). To begin work on the document, you can fork the repository and then edit it either locally using your preferred LaTeX editor or by importing it to Overleaf. When you are done with the editing, you can update the forked repository through Overleaf, and then create a pull request from the fork by incorporating the recently made changes.