Skip to main content

A package to convert Brillouin spectra to a HDF5 file and use them

Project description

HDF5_BLS

HDF5_BLS is a Python library for handling Brillouin Light Scattering (BLS) data and converting it into a standardized HDF5 format. The library provides functions to open raw data files, define and import abscissa, add metadata, and save the organized data in HDF5 files. The library is currently compatible with the following file formats:

  • "*.dat" files: dat spectra obtained with:
    • GHOST software
    • Time Domain measures (format defined by Sal La Cavera)
  • "*.npy" files: a numpy file
  • "*.sif" files: image files obtained with Andor cameras
  • All image files supported by the Pillow library (see this link)

GUI

The GUI is now capable of:

  • Create new HDF5 files following the structure of v1.0.0:
    • Structure the file in a hierarchical way
    • Import measure data (drag and drop functionality implemented)
    • Import measure data from a CSV file (drag and drop functionality implemented)
    • Modify parameters of data both by group and individually from the GUI
  • Export sub-HDF5 files from meta files
  • Export Python code to access individual datasets
  • Analyze raw spectra obtained with a VIPA spectrometer

Library

Library installation

You can install HDF5_BLS directly from PyPI:

pip install HDF5_BLS

Please refer to the tutorial for more information.

Documentation

You can access the documentation of the project at this link. Additionnally, a ReadTheDocs documentation for the library is accessible at this link.

Contributing

A Developper Guide is accessible at this link. This guide is meant to be used by researchers who want to expand the project to their own devices while keeping the compatibility with all the existing functionalities.

For changes that might affect the compatibility of the project with existing devices, please open an issue first to discuss what you would like to change. For more information, please refer to CONTRIBUTING.md.

License

GNU-GPL v3.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hdf5_bls-0.1.1.tar.gz (54.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hdf5_bls-0.1.1-py3-none-any.whl (57.7 kB view details)

Uploaded Python 3

File details

Details for the file hdf5_bls-0.1.1.tar.gz.

File metadata

  • Download URL: hdf5_bls-0.1.1.tar.gz
  • Upload date:
  • Size: 54.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for hdf5_bls-0.1.1.tar.gz
Algorithm Hash digest
SHA256 13d25956957328ef327f6b56973c4e08cff38e1cbd1ed5b04f309aaa897f344c
MD5 e6fd45e9472d8b03e5481e4e526e3300
BLAKE2b-256 9cfb709d01e13d6d418d0aa81fd33284ea3488a505f2c6c267d9925740ff60ec

See more details on using hashes here.

File details

Details for the file hdf5_bls-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: hdf5_bls-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 57.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for hdf5_bls-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 04d014e7c45bf0cc987026c3db7f5f8c4455f5480013696779fe251ea554877b
MD5 5ca5546b26c51688e2e2e839e809fb1b
BLAKE2b-256 fa5959fc7290769933229f4cd575b0d02fd551714c3202d614b64ca3e8ecfa67

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page