https://github.com/diamondlightsource/python-swmrtools

A collection of tools for working with HDF5 files whilst open in SWMR mode
https://github.com/diamondlightsource/python-swmrtools

Last synced: 11 months ago
JSON representation

A collection of tools for working with HDF5 files whilst open in SWMR mode

• Host: GitHub
• URL: https://github.com/diamondlightsource/python-swmrtools
• Owner: DiamondLightSource
• License: mit
• Created: 2020-11-03T14:29:50.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-10-26T07:24:32.000Z (over 2 years ago)
• Last Synced: 2024-04-30T03:23:20.576Z (almost 2 years ago)
• Language: Python
• Size: 162 KB
• Stars: 1
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# swmr_tools

[![PyPI release](https://img.shields.io/pypi/v/swmr-tools.svg)](https://pypi.org/project/swmr-tools/) [![Test status](https://github.com/DiamondLightSource/python-swmrtools/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/python-swmrtools/actions/workflows/ci.yml) [![Docs](https://readthedocs.org/projects/python-swmrtools/badge/?version=latest)](https://python-swmrtools.readthedocs.io/en/latest/?badge=latest)

swmr_tools is a Python library developed by Diamond Light Source Ltd designed to facilitate reading and processing data from HDF5 swmr files as they are being written.

## Installation

swmr_tools can be installed using either conda [(from the conda-forge channel)](https://anaconda.org/conda-forge/swmr-tools):

```bash

conda install -c conda-forge swmr-tools

```

or the package manager [pip](https://pip.pypa.io/en/stable/):

```bash

pip install swmr_tools

```

## Usage

- For full examples of use please see the full documentation at https://python-swmrtools.readthedocs.io

- Jupyter notebook tutorials for key functionality can be found in the tutorial directory in the git repository