| Name | h5pywrappers JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | None |
| Summary | Contains several functions used to facilitate loading data from and saving data to HDF5 files. These functions are wrappers that call functions from the library ``h5py``. |
| upload_time | 2025-10-24 23:10:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
hdf5
h5py
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# H5py Wrappers (H5pyWrappers)
[](https://github.com/mrfitzpa/h5pywrappers/actions/workflows/test_library.yml)
[](https://github.com/mrfitzpa/h5pywrappers/actions/workflows/measure_code_coverage.yml)
[](https://mrfitzpa.github.io/h5pywrappers)
[](https://pypi.org/project/h5pywrappers)
[](https://anaconda.org/conda-forge/h5pywrappers)
[](https://www.gnu.org/licenses/gpl-3.0)
`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`](https://docs.h5py.org/en/stable/) library.
Visit the `h5pywrappers` [website](https://mrfitzpa.github.io/h5pywrappers) 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](https://github.com/mrfitzpa/h5pywrappers).
## Table of contents
- [Instructions for installing and uninstalling
`h5pywrappers`](#instructions-for-installing-and-uninstalling-h5pywrappers)
- [Installing `h5pywrappers`](#installing-h5pywrappers)
- [Installing `h5pywrappers` using
`pip`](#installing-h5pywrappers-using-pip)
- [Installing `h5pywrappers` using
`conda`](#installing-h5pywrappers-using-conda)
- [Uninstalling `h5pywrappers`](#uninstalling-h5pywrappers)
- [Learning how to use `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](https://github.com/mrfitzpa/h5pywrappers), 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](https://mrfitzpa.github.io/h5pywrappers/examples.html)
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](https://mrfitzpa.github.io/h5pywrappers/_autosummary/h5pywrappers.html)
to understand what each line of code is doing.
Raw data
{
"_id": null,
"home_page": null,
"name": "h5pywrappers",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "HDF5, h5py",
"author": null,
"author_email": "Matthew Fitzpatrick <matthew.rc.fitzpatrick@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a2/d6/1e68b017b5425be68942c54c5b0840b382978b9643c45b9d1ea3be216896/h5pywrappers-0.0.5.tar.gz",
"platform": null,
"description": "# H5py Wrappers (H5pyWrappers)\n\n[](https://github.com/mrfitzpa/h5pywrappers/actions/workflows/test_library.yml)\n[](https://github.com/mrfitzpa/h5pywrappers/actions/workflows/measure_code_coverage.yml)\n[](https://mrfitzpa.github.io/h5pywrappers)\n[](https://pypi.org/project/h5pywrappers)\n[](https://anaconda.org/conda-forge/h5pywrappers)\n[](https://www.gnu.org/licenses/gpl-3.0)\n\n`h5pywrappers` is a simple Python library that contains several functions used\nto facilitate loading data from and saving data to HDF5 files. These functions\nare wrappers that call functions from the\n[`h5py`](https://docs.h5py.org/en/stable/) library.\n\nVisit the `h5pywrappers` [website](https://mrfitzpa.github.io/h5pywrappers) for\na web version of the installation instructions, the reference guide, and the\nexamples archive.\n\nThe source code can be found in the [`h5pywrappers` GitHub\nrepository](https://github.com/mrfitzpa/h5pywrappers).\n\n\n\n## Table of contents\n\n- [Instructions for installing and uninstalling\n `h5pywrappers`](#instructions-for-installing-and-uninstalling-h5pywrappers)\n - [Installing `h5pywrappers`](#installing-h5pywrappers)\n - [Installing `h5pywrappers` using\n `pip`](#installing-h5pywrappers-using-pip)\n - [Installing `h5pywrappers` using\n `conda`](#installing-h5pywrappers-using-conda)\n - [Uninstalling `h5pywrappers`](#uninstalling-h5pywrappers)\n- [Learning how to use `h5pywrappers`](#learning-how-to-use-h5pywrappers)\n\n\n\n## Instructions for installing and uninstalling `h5pywrappers`\n\n\n\n### Installing `h5pywrappers`\n\nFor all installation scenarios, first open up the appropriate command line\ninterface. On Unix-based systems, you could open e.g. a terminal. On Windows\nsystems you could open e.g. an Anaconda Prompt as an administrator.\n\n\n\n#### Installing `h5pywrappers` using `pip`\n\nBefore installing `h5pywrappers`, make sure that you have activated the\n(virtual) environment in which you intend to install said package. After which,\nsimply run the following command:\n\n pip install h5pywrappers\n\nThe above command will install the latest stable version of `h5pywrappers`.\n\nTo install the latest development version from the main branch of the\n[h5pywrappers GitHub repository](https://github.com/mrfitzpa/h5pywrappers), one\nmust first clone the repository by running the following command:\n\n git clone https://github.com/mrfitzpa/h5pywrappers.git\n\nNext, change into the root of the cloned repository, and then run the following\ncommand:\n\n pip install .\n\nNote that you must include the period as well. The above command executes a\nstandard installation of `h5pywrappers`.\n\nOptionally, for additional features in `h5pywrappers`, one can install\nadditional dependencies upon installing `h5pywrappers`. To install a subset of\nadditional dependencies (along with the standard installation), run the\nfollowing command from the root of the repository:\n\n pip install .[<selector>]\n\nwhere `<selector>` can be one of the following:\n\n* `tests`: to install the dependencies necessary for running unit tests;\n* `examples`: to install the dependencies necessary for executing files stored\n in `<root>/examples`, where `<root>` is the root of the repository;\n* `docs`: to install the dependencies necessary for documentation generation;\n* `all`: to install all of the above optional dependencies.\n\nAlternatively, one can run:\n\n pip install h5pywrappers[<selector>]\n\nelsewhere in order to install the latest stable version of `h5pywrappers`, along\nwith the subset of additional dependencies specified by `<selector>`.\n\n\n\n#### Installing `h5pywrappers` using `conda`\n\nTo install `h5pywrappers` using the `conda` package manager, run the following\ncommand:\n\n conda install -c conda-forge h5pywrappers\n\nThe above command will install the latest stable version of `h5pywrappers`.\n\n\n\n### Uninstalling `h5pywrappers`\n\nIf `h5pywrappers` was installed using `pip`, then to uninstall, run the\nfollowing command:\n\n pip uninstall h5pywrappers\n\nIf `h5pywrappers` was installed using `conda`, then to uninstall, run the\nfollowing command:\n\n conda remove h5pywrappers\n\n\n\n## Learning how to use `h5pywrappers`\n\nFor those new to the `h5pywrappers` library, it is recommended that they take a\nlook at the [Examples](https://mrfitzpa.github.io/h5pywrappers/examples.html)\npage, which contain code examples that show how one can use the `h5pywrappers`\nlibrary. While going through the examples, readers can consult the [h5pywrappers\nreference\nguide](https://mrfitzpa.github.io/h5pywrappers/_autosummary/h5pywrappers.html)\nto understand what each line of code is doing.\n",
"bugtrack_url": null,
"license": null,
"summary": "Contains several functions used to facilitate loading data from and saving data to HDF5 files. These functions are wrappers that call functions from the library ``h5py``.",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://mrfitzpa.github.io/h5pywrappers",
"Repository": "https://github.com/mrfitzpa/h5pywrappers"
},
"split_keywords": [
"hdf5",
" h5py"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9b7153e7ca1c307be3f169fadc954efeba0fb541669cfd3afecdf92ab2bdd7ed",
"md5": "ed17344c1233f395f139f88bd2a28bee",
"sha256": "5fc1e02f49a32b60051c50754cd2edd53ae1c67792ab5159ba9738ae053de53e"
},
"downloads": -1,
"filename": "h5pywrappers-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed17344c1233f395f139f88bd2a28bee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 39705,
"upload_time": "2025-10-24T23:10:54",
"upload_time_iso_8601": "2025-10-24T23:10:54.418161Z",
"url": "https://files.pythonhosted.org/packages/9b/71/53e7ca1c307be3f169fadc954efeba0fb541669cfd3afecdf92ab2bdd7ed/h5pywrappers-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a2d61e68b017b5425be68942c54c5b0840b382978b9643c45b9d1ea3be216896",
"md5": "76d12cb32dda034b2cd0550cafa525c0",
"sha256": "80f0a98f55938d6d91360813862362b453498acd8ef7ee266eac23c5e6aaeb94"
},
"downloads": -1,
"filename": "h5pywrappers-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "76d12cb32dda034b2cd0550cafa525c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 50590,
"upload_time": "2025-10-24T23:10:55",
"upload_time_iso_8601": "2025-10-24T23:10:55.807454Z",
"url": "https://files.pythonhosted.org/packages/a2/d6/1e68b017b5425be68942c54c5b0840b382978b9643c45b9d1ea3be216896/h5pywrappers-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 23:10:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mrfitzpa",
"github_project": "h5pywrappers",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "h5pywrappers"
}
