H5py Wrappers (H5pyWrappers)

h5pywrappers is a simple Python library that contains several functions used to facilitate loading data from and saving data to HDF5 files. These functions are wrappers that call functions from the h5py library.

Visit the h5pywrappers website for a web version of the installation instructions, the reference guide, and the examples archive.

The source code can be found in the h5pywrappers GitHub repository.

Table of contents

• Instructions for installing and uninstalling h5pywrappers
  • Installing h5pywrappers
    • Installing h5pywrappers using pip
    • Installing h5pywrappers using conda
  • Uninstalling h5pywrappers
• Learning how to use h5pywrappers

Instructions for installing and uninstalling h5pywrappers

Installing h5pywrappers

For all installation scenarios, first open up the appropriate command line interface. On Unix-based systems, you could open e.g. a terminal. On Windows systems you could open e.g. an Anaconda Prompt as an administrator.

Installing h5pywrappers using pip

Before installing h5pywrappers, make sure that you have activated the (virtual) environment in which you intend to install said package. After which, simply run the following command:

pip install h5pywrappers

The above command will install the latest stable version of h5pywrappers.

To install the latest development version from the main branch of the h5pywrappers GitHub repository, one must first clone the repository by running the following command:

git clone https://github.com/mrfitzpa/h5pywrappers.git

Next, change into the root of the cloned repository, and then run the following command:

pip install .

Note that you must include the period as well. The above command executes a standard installation of h5pywrappers.

Optionally, for additional features in h5pywrappers, one can install additional dependencies upon installing h5pywrappers. To install a subset of additional dependencies (along with the standard installation), run the following command from the root of the repository:

pip install .[<selector>]

where <selector> can be one of the following:

• tests: to install the dependencies necessary for running unit tests;
• examples: to install the dependencies necessary for executing files stored in <root>/examples, where <root> is the root of the repository;
• docs: to install the dependencies necessary for documentation generation;
• all: to install all of the above optional dependencies.

Alternatively, one can run:

pip install h5pywrappers[<selector>]

elsewhere in order to install the latest stable version of h5pywrappers, along with the subset of additional dependencies specified by <selector>.

Installing h5pywrappers using conda

To install h5pywrappers using the conda package manager, run the following command:

conda install -c conda-forge h5pywrappers

The above command will install the latest stable version of h5pywrappers.

Uninstalling h5pywrappers

If h5pywrappers was installed using pip, then to uninstall, run the following command:

pip uninstall h5pywrappers

If h5pywrappers was installed using conda, then to uninstall, run the following command:

conda remove h5pywrappers

Learning how to use h5pywrappers

For those new to the h5pywrappers library, it is recommended that they take a look at the Examples page, which contain code examples that show how one can use the h5pywrappers library. While going through the examples, readers can consult the h5pywrappers reference guide to understand what each line of code is doing.