1What's new in h5py 2.6
2======================
3
4Support for HDF5 Virtual Dataset API
5------------------------------------
6Initial support for the HDF5 Virtual Dataset API, which was introduced in
7HDF5 1.10, was added to the low-level API. Ideas and input for how this should
8work as part of the high-level interface are welcome.
9
10This work was added in `#663`_ by Aleksandar Jelenak.
11
12Add MPI Collective I/O Support
13------------------------------
14Support for using MPI Collective I/O in both low-level and high-level code has
15been added. See the collective_io.py example for a simple demonstration of how
16to use MPI Collective I/O with the high level API.
17
18This work was added in `#648`_ by Jialin Liu.
19
20Numerous build/testing/CI improvements
21--------------------------------------
22There were a number of improvements to the setup.py file, which should mean that
23`pip install h5py` should work in most places. Work was also done to clean up
24the current testing system, using tox is the recommended way of testing h5py
25across different Python versions. See `#576`_ by Jakob Lombacher, `#640`_ by
26Lawrence Mitchell, and `#650`_, `#651`_ and `#658`_ by James Tocknell.
27
28Cleanup of codebase based on pylint
29-----------------------------------
30There was a large cleanup of pylint-identified problems by Andrew Collette
31(`#578`_, `#579`_).
32
33Fixes to low-level API
34----------------------
35Fixes to the typing of functions were added in `#597`_ by Ulrik Kofoed
36Pedersen, `#589`_ by Peter Chang, and `#625`_ by Spaghetti Sort. A fix for
37variable-length arrays was added in `#621`_ by Sam Mason. Fixes to compound
38types were added in `#639`_ by @nevion and `#606`_ by Yu Feng. Finally, a fix
39to type conversion was added in `#614`_ by Andrew Collette.
40
41Documentation improvements
42--------------------------
43* Updates to FAQ by Dan Guest (`#608`_) and Peter Hill (`#607`_).
44* Updates MPI-related documentation by Jens Timmerman (`#604`_) and
45  Matthias König (`#572`_).
46* Fixes to documentation building by Ghislain Antony Vaillant (`#562`_,
47  `#561`_).
48* Update PyTables link (`#574`_ by Dominik Kriegner)
49* Add File opening modes to docstring (`#563`_ by Antony Lee)
50
51Other changes
52-------------
53* Add `Dataset.ndim` (`#649`_, `#660`_ by @jakirkham, `#661`_ by James Tocknell)
54* Fix import errors in IPython completer (`#605`_ by Niru Maheswaranathan)
55* Turn off error printing in new threads (`#583`_ by Andrew Collette)
56* Use item value in `KeyError` instead of error message (`#642`_ by Matthias Geier)
57
58
59.. _`#561` : https://github.com/h5py/h5py/pull/561
60.. _`#562` : https://github.com/h5py/h5py/pull/562
61.. _`#563` : https://github.com/h5py/h5py/pull/563
62.. _`#572` : https://github.com/h5py/h5py/pull/572
63.. _`#574` : https://github.com/h5py/h5py/pull/574
64.. _`#576` : https://github.com/h5py/h5py/pull/576
65.. _`#578` : https://github.com/h5py/h5py/pull/578
66.. _`#579` : https://github.com/h5py/h5py/pull/579
67.. _`#583` : https://github.com/h5py/h5py/pull/583
68.. _`#589` : https://github.com/h5py/h5py/pull/589
69.. _`#597` : https://github.com/h5py/h5py/pull/597
70.. _`#604` : https://github.com/h5py/h5py/pull/604
71.. _`#605` : https://github.com/h5py/h5py/pull/605
72.. _`#606` : https://github.com/h5py/h5py/pull/606
73.. _`#607` : https://github.com/h5py/h5py/pull/607
74.. _`#608` : https://github.com/h5py/h5py/pull/608
75.. _`#614` : https://github.com/h5py/h5py/pull/614
76.. _`#621` : https://github.com/h5py/h5py/pull/621
77.. _`#625` : https://github.com/h5py/h5py/pull/625
78.. _`#639` : https://github.com/h5py/h5py/pull/639
79.. _`#640` : https://github.com/h5py/h5py/pull/640
80.. _`#642` : https://github.com/h5py/h5py/pull/642
81.. _`#648` : https://github.com/h5py/h5py/pull/648
82.. _`#649` : https://github.com/h5py/h5py/pull/649
83.. _`#650` : https://github.com/h5py/h5py/pull/650
84.. _`#651` : https://github.com/h5py/h5py/pull/651
85.. _`#658` : https://github.com/h5py/h5py/pull/658
86.. _`#660` : https://github.com/h5py/h5py/pull/660
87.. _`#661` : https://github.com/h5py/h5py/pull/661
88.. _`#663` : https://github.com/h5py/h5py/pull/663
89
90Acknowledgements
91----------------
92