README.rst
1.. image:: https://travis-ci.org/h5py/h5py.png
2 :target: https://travis-ci.org/h5py/h5py
3.. image:: https://ci.appveyor.com/api/projects/status/h3iajp4d1myotprc/branch/master?svg=true
4 :target: https://ci.appveyor.com/project/h5py/h5py/branch/master
5.. image:: https://dev.azure.com/h5pyappveyor/h5py/_apis/build/status/h5py.h5py?branchName=master
6 :target: https://dev.azure.com/h5pyappveyor/h5py/_build/latest?definitionId=1&branchName=master
7
8HDF5 for Python
9===============
10`h5py` is a thin, pythonic wrapper around `HDF5 <https://portal.hdfgroup.org/display/HDF5/>`_,
11which runs on Python 3 (3.6+).
12
13Websites
14--------
15
16* Main website: https://www.h5py.org
17* Source code: https://github.com/h5py/h5py
18* Mailing list: https://groups.google.com/d/forum/h5py
19
20Installation
21------------
22
23Pre-build `h5py` can either be installed via your Python Distribution (e.g.
24`Continuum Anaconda`_, `Enthought Canopy`_) or from `PyPI`_ via `pip`_.
25`h5py` is also distributed in many Linux Distributions (e.g. Ubuntu, Fedora),
26and in the MacOS package managers `Homebrew <https://brew.sh/>`_,
27`Macports <https://www.macports.org/>`_, or `Fink <http://finkproject.org/>`_.
28
29More detailed installation instructions, including how to install `h5py` with
30MPI support, can be found at: https://docs.h5py.org/en/latest/build.html.
31
32
33Reporting bugs
34--------------
35
36Open a bug at https://github.com/h5py/h5py/issues. For general questions, ask
37on the HDF forum (https://forum.hdfgroup.org/c/hdf-tools/h5py).
38
39.. _`Continuum Anaconda`: http://continuum.io/downloads
40.. _`Enthought Canopy`: https://www.enthought.com/products/canopy/
41.. _`PyPI`: https://pypi.org/project/h5py/
42.. _`pip`: https://pip.pypa.io/en/stable/
43