hdmf 4.3.1
A hierarchical data modeling framework for modern science data standards
Requires Python: >=3.9

========================================
The Hierarchical Data Modeling Framework
========================================

The Hierarchical Data Modeling Framework, or *HDMF*, is a Python package for working with hierarchical data.
It provides APIs for specifying data models, reading and writing data to different storage backends, and
representing data with Python objects.

Documentation of HDMF can be found at https://hdmf.readthedocs.io.

Latest Release
==============

.. image:: https://badge.fury.io/py/hdmf.svg
     :target: https://badge.fury.io/py/hdmf

.. image:: https://anaconda.org/conda-forge/hdmf/badges/version.svg
     :target: https://anaconda.org/conda-forge/hdmf

.. image:: https://zenodo.org/badge/167271700.svg
  :target: https://doi.org/10.5281/zenodo.8034516

Overall Health
==============

.. image:: https://github.com/hdmf-dev/hdmf/actions/workflows/run_coverage.yml/badge.svg
    :target: https://github.com/hdmf-dev/hdmf/actions/workflows/run_coverage.yml

.. image:: https://github.com/hdmf-dev/hdmf/actions/workflows/run_tests.yml/badge.svg
    :target: https://github.com/hdmf-dev/hdmf/actions/workflows/run_tests.yml

.. image:: https://github.com/hdmf-dev/hdmf/actions/workflows/codespell.yml/badge.svg
    :target: https://github.com/hdmf-dev/hdmf/actions/workflows/codespell.yml

.. image:: https://github.com/hdmf-dev/hdmf/actions/workflows/ruff.yml/badge.svg
    :target: https://github.com/hdmf-dev/hdmf/actions/workflows/ruff.yml

.. image:: https://github.com/hdmf-dev/hdmf/actions/workflows/check_sphinx_links.yml/badge.svg
    :target: https://github.com/hdmf-dev/hdmf/actions/workflows/check_sphinx_links.yml

.. image:: https://github.com/hdmf-dev/hdmf/actions/workflows/run_pynwb_tests.yml/badge.svg
    :target: https://github.com/hdmf-dev/hdmf/actions/workflows/run_pynwb_tests.yml

.. image:: https://github.com/hdmf-dev/hdmf/actions/workflows/run_hdmf_zarr_tests.yml/badge.svg
    :target: https://github.com/hdmf-dev/hdmf/actions/workflows/run_hdmf_zarr_tests.yml

.. image:: https://github.com/hdmf-dev/hdmf/actions/workflows/run_nwb_extension_tests.yml/badge.svg
    :target: https://github.com/hdmf-dev/hdmf/actions/workflows/run_nwb_extension_tests.yml

.. image:: https://github.com/hdmf-dev/hdmf/actions/workflows/run_all_tests.yml/badge.svg
    :target: https://github.com/hdmf-dev/hdmf/actions/workflows/run_all_tests.yml

.. image:: https://github.com/hdmf-dev/hdmf/actions/workflows/deploy_release.yml/badge.svg
    :target: https://github.com/hdmf-dev/hdmf/actions/workflows/deploy_release.yml

.. image:: https://codecov.io/gh/hdmf-dev/hdmf/branch/dev/graph/badge.svg
    :target: https://codecov.io/gh/hdmf-dev/hdmf

.. image:: https://readthedocs.org/projects/hdmf/badge/?version=stable
     :target: https://hdmf.readthedocs.io/en/stable/?badge=stable
     :alt: Documentation Status

Installation
============

See the `HDMF documentation <https://hdmf.readthedocs.io/en/stable/install_users.html>`_.

Code of Conduct
===============

This project and everyone participating in it is governed by our `code of conduct guidelines <https://github.com/hdmf-dev/hdmf/blob/dev/.github/CODE_OF_CONDUCT.md>`_. By participating, you are expected to uphold this code.

Contributing
============

For details on how to contribute to HDMF see our `contribution guidelines <https://github.com/hdmf-dev/hdmf/blob/dev/docs/CONTRIBUTING.rst>`_.

Citing HDMF
===========

* **Manuscript:**

.. code-block:: bibtex

  @INPROCEEDINGS{9005648,
    author={A. J. {Tritt} and O. {Rübel} and B. {Dichter} and R. {Ly} and D. {Kang} and E. F. {Chang} and L. M. {Frank} and K. {Bouchard}},
    booktitle={2019 IEEE International Conference on Big Data (Big Data)},
    title={HDMF: Hierarchical Data Modeling Framework for Modern Science Data Standards},
    year={2019},
    volume={},
    number={},
    pages={165-179},
    doi={10.1109/BigData47090.2019.9005648},
    note={}}

* **RRID:**  (Hierarchical Data Modeling Framework, RRID:SCR_021303)


LICENSE
=======

"hdmf" Copyright (c) 2017-2026, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy).  All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

(1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

(3) Neither the name of the University of California, Lawrence Berkeley National Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code ("Enhancements") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to Lawrence Berkeley National Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a  non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such enhancements or derivative works thereof, in binary and source code form.

COPYRIGHT
=========

"hdmf" Copyright (c) 2017-2026, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy).  All rights reserved.
If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Innovation & Partnerships Office at IPO@lbl.gov.

NOTICE.  This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit other to do so.