Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!--
Thank you for contributing to our project!

Please do not delete this text completely, but read the text below and keep
items that seem relevant. If in doubt, just keep everything and add your
own text at the top, a reviewer will update the checklist for you.

-->

## Description

<!--
Please describe your changes here, especially focusing on why this pull
request makes PyActiveStorage better and what problem it solves.

Please fill in the GitHub issue that is closed by this pull request,
e.g. Closes #1903
-->

Closes #issue_number


## Before you get started

- [ ] [☝ Create an issue](https://github.com/NCAS-CMS/pyfive/issues) to discuss what you are going to do

## Checklist

- [ ] This pull request has a descriptive title and labels
- [ ] This pull request has a minimal description (most was discussed in the issue, but a two-liner description is still desirable)
- [ ] Unit tests have been added (if codecov test fails)
- [ ] Any changed dependencies have been added or removed correctly (if need be)
- [ ] If you are working on the documentation, please ensure the [current build](xxx) passes
- [ ] All tests pass
35 changes: 11 additions & 24 deletions README.rst → README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
[![Test](https://github.com/NCAS-CMS/pyfive/actions/workflows/pytest.yml/badge.svg)](https://github.com/NCAS-CMS/pyfive/actions/workflows/pytest.yml)

pyfive : A pure Python HDF5 file reader
=======================================

|Travis|_

.. |Travis| image:: https://api.travis-ci.org/jjhelmus/pyfive.png?branch=master
.. _Travis: https://travis-ci.org/jjhelmus/pyfive

pyfive is an open source library for reading HDF5 files written using
pure Python (no C extensions). The package is still in development and not all
features of HDF5 files are supported. For a more mature Python library for
read and writing HDF5 files, try `h5py`_.
features of HDF5 files are supported.

pyfive aims to support the same API as `h5py`_ for reading files. Cases where a
file uses a feature that is supported by `h5py`_ but not pyfive are considered
bug and should be reported on the `issue tracker`_. Writing HDF5 is not a goal
of pyfive and portions of the API which apply only to writing will not be
pyfive aims to support the same API as [`h5py`](https://github.com/h5py/h5py)
for reading files. Cases where a file uses a feature that is supported by `h5py`
but not pyfive are considered bug and should be reported in our [Issues](https://github.com/NCAS-CMS/pyfive/issues).
Writing HDF5 is not a goal of pyfive and portions of the API which apply only to writing will not be
implemented.

.. _h5py: http://www.h5py.org/
.. _issue tracker: https://github.com/jjhelmus/pyfive/issues

Dependencies
============

Expand All @@ -35,7 +30,7 @@ pyfive can be installed using pip using the command::

pip install pyfive

conda package are also available from `conda-forge`_ which can be installed::
conda package are also available from conda-forge which can be installed::

conda install -c conda-forge pyfive

Expand All @@ -45,7 +40,6 @@ To install from source in your home directory use::

The library can also be imported directly from the source directory.

.. _conda-forge: https://conda-forge.github.io/

Development
===========
Expand All @@ -55,18 +49,11 @@ git

You can check out the latest pyfive souces with the command::

git clone https://github.com/jjhelmus/pyfive.git
git clone https://github.com/NCAS-CMS/pyfive.git

testing
-------

pyfive comes with a test suite in the ``tests`` directory. These tests can be
exercised using the commands ``pytest`` from the root directory assuming the
``pytest`` package is installed.

Related Projects
================

`jsfive`_ is a pure javascript HDF5 file reader based on pyfive.

.. _jsfive: https://github.com/usnistgov/jsfive
Loading