Metadata-Version: 2.4
Name: brimfile
Version: 1.1.3
Summary: A package to read and write to the brim file format, containing spectral data and metadata from Brillouin microscopy
Project-URL: Documentation, https://prevedel-lab.github.io/brimfile/
Project-URL: Repository, https://github.com/prevedel-lab/brimfile
Project-URL: Issues, https://github.com/prevedel-lab/brimfile/issues
Author-email: Carlo Bevilacqua <carlo.bevilacqua@embl.de>, Sebastian Hambura <sebastian.hambura@embl.de>
License-Expression: LGPL-3.0-or-later
License-File: LICENSE.toml
Keywords: Brillouin microscopy
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: File Formats
Classifier: Topic :: Scientific/Engineering
Requires-Dist: numpy
Requires-Dist: zarr>=3.0
Provides-Extra: export-tiff
Requires-Dist: tifffile; extra == 'export-tiff'
Provides-Extra: remote-store
Requires-Dist: s3fs; extra == 'remote-store'
Requires-Dist: zarr[remote]>=3; extra == 'remote-store'
Description-Content-Type: text/markdown

# brimfile package

## What is it?

*brimfile* is a package to read and write to brim (**Br**illouin **im**aging) files, containing spectral data and metadata from Brillouin microscopy.

The detailed specs of the brim file format can be found [here](https://github.com/prevedel-lab/Brillouin-standard-file/blob/main/docs/brim_file_specs.md).

## Where to get it

*brimfile* can be installed from PyPI using `pip`:
```bash
pip install brimfile
```

## How to use it

The documentation of the package can be found [here](https://prevedel-lab.github.io/brimfile/).