nirs4all-formats (Python)

Python bindings for nirs4all-formats, the Rust-first low-level reader for NIRS and spectroscopy file formats. It reads ~58 format families, auto-detecting each file by content, and projects the canonical records into numpy / pandas / polars / sklearn / torch / xarray or a nirs4all SpectroDataset.

Parsers live entirely in the Rust core — this package is a thin, lossless surface over it.

Install

pip install nirs4all-formats                                  # Python 3.10+
pip install nirs4all-formats                                  # includes NumPy
pip install "nirs4all-formats[pandas,sklearn,torch]"          # other projection extras

to_polars() needs polars, to_xarray() needs xarray, and to_spectrodataset() needs nirs4all.

Quick start

import nirs4all_formats as nio

# Probe: which reader will handle this file, and why?
nio.probe_path("spectrum.jdx")

# Lossless object model — every signal, axis, coord, metadata and provenance
rs = nio.open_recordset("spectrum.sed")
rs.signal_names()

# Modelling-ready projections (explicit; may be lossy)
X, axis = rs.to_numpy(signal="reflectance")   # (X[n_samples, n_features], axis)
df      = rs.to_pandas()                        # wide: metadata + x_<axis> columns
bunch   = rs.to_sklearn(signal="reflectance", target="protein")

API at a glance

Raw access (records exactly as the Rust core emits them, as dicts): open_records, open_bytes, open_with_sidecars, probe_path, walk_path.

Object model: open_recordset(path) -> SpectralRecordSet with dataclasses SpectralRecord, SpectralArray, SpectralAxis, SourceFile, Provenance.

Projections on SpectralRecordSet: to_numpy, to_pandas, to_pandas_long, to_polars, to_sklearn, to_torch, to_spectrodataset; SpectralArray.to_xarray() for N-dimensional signals (cubes, maps, series).

Image-cube readers accept pixel selection: rows=/cols= (rectangular ROI), pixels=[(r, c), …] (sparse), or single_record=True to keep the spatial grid.

A native PyO3 extension (nirs4all_formats._native) is used when present; otherwise the bridge falls back to the nirs4all-formats CLI (NIRS4ALL_FORMATS_CLI can point to a prebuilt binary).

Documentation

Full reference: https://github.com/GBeurier/nirs4all-formats/blob/main/docs/bindings/python.md. The usage guide, supported-format catalogue and data model live in the project docs.

License

CeCILL-2.1 OR AGPL-3.0-or-later. See the repository LICENSING.md.

Download files

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

Source Distribution

nirs4all_formats-0.2.8.tar.gz (770.0 kB view details)

Uploaded Sep 3, 2026 Source

Built Distributions

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

nirs4all_formats-0.2.8-cp310-abi3-win_amd64.whl (4.3 MB view details)

Uploaded Sep 3, 2026 CPython 3.10+Windows x86-64

nirs4all_formats-0.2.8-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (4.8 MB view details)

Uploaded Sep 3, 2026 CPython 3.10+manylinux: glibc 2.17+ x86-64

File details

Details for the file nirs4all_formats-0.2.8.tar.gz.

File metadata

Download URL: nirs4all_formats-0.2.8.tar.gz
Upload date: Sep 3, 2026
Size: 770.0 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for nirs4all_formats-0.2.8.tar.gz
Algorithm	Hash digest
SHA256	`e0e38bf54dc1e47ecc1fa5c63d051036305c02579bb437955821f5e8b8b43e11`
MD5	`595e2030ba05bd452dca06b8f2cc772f`
BLAKE2b-256	`958b13886a84d90d7e2841b3690133d3d84bf603a218bfce6d36d10e9908c955`

See more details on using hashes here.

Provenance

The following attestation bundles were made for nirs4all_formats-0.2.8.tar.gz:

Publisher: release.yml on GBeurier/nirs4all-formats

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: nirs4all_formats-0.2.8.tar.gz
- Subject digest: e0e38bf54dc1e47ecc1fa5c63d051036305c02579bb437955821f5e8b8b43e11
- Sigstore transparency entry: 2698205373
- Sigstore integration time: Sep 3, 2026
Source repository:
- Permalink: GBeurier/nirs4all-formats@2d46285843dc366da1d38f133131b5329c886b12
- Branch / Tag: refs/tags/v0.2.8
- Owner: https://github.com/GBeurier
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@2d46285843dc366da1d38f133131b5329c886b12
- Trigger Event: push

File details

Details for the file nirs4all_formats-0.2.8-cp310-abi3-win_amd64.whl.

File metadata

Download URL: nirs4all_formats-0.2.8-cp310-abi3-win_amd64.whl
Upload date: Sep 3, 2026
Size: 4.3 MB
Tags: CPython 3.10+, Windows x86-64
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for nirs4all_formats-0.2.8-cp310-abi3-win_amd64.whl
Algorithm	Hash digest
SHA256	`98b2b162ddc011bd4be5071a2bf9cde4dfbbf9628e3a9d2d32a0223f38e876ee`
MD5	`c190481cf9032668cc22d3cd554ec7e5`
BLAKE2b-256	`1dafc2295bbe7ff30be31e1b830fff210b42a6ddbe5ee022f3c4e58d08f5b989`

See more details on using hashes here.

Provenance

The following attestation bundles were made for nirs4all_formats-0.2.8-cp310-abi3-win_amd64.whl:

Publisher: release.yml on GBeurier/nirs4all-formats

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: nirs4all_formats-0.2.8-cp310-abi3-win_amd64.whl
- Subject digest: 98b2b162ddc011bd4be5071a2bf9cde4dfbbf9628e3a9d2d32a0223f38e876ee
- Sigstore transparency entry: 2698205408
- Sigstore integration time: Sep 3, 2026
Source repository:
- Permalink: GBeurier/nirs4all-formats@2d46285843dc366da1d38f133131b5329c886b12
- Branch / Tag: refs/tags/v0.2.8
- Owner: https://github.com/GBeurier
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@2d46285843dc366da1d38f133131b5329c886b12
- Trigger Event: push

File details

Details for the file nirs4all_formats-0.2.8-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.

File metadata

Download URL: nirs4all_formats-0.2.8-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Upload date: Sep 3, 2026
Size: 4.8 MB
Tags: CPython 3.10+, manylinux: glibc 2.17+ x86-64
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for nirs4all_formats-0.2.8-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Algorithm	Hash digest
SHA256	`9300a7de1076a06863883e4f47606673102b91e0295f3a2e0b74b51b4b17852b`
MD5	`d3eabaa88509a00a320fa485162aa69f`
BLAKE2b-256	`1449909ecd39064d3b39b91286b3988ed162870920e0f48d8c912d9aa6caf2cd`

See more details on using hashes here.

Provenance

The following attestation bundles were made for nirs4all_formats-0.2.8-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl:

Publisher: release.yml on GBeurier/nirs4all-formats

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: nirs4all_formats-0.2.8-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
- Subject digest: 9300a7de1076a06863883e4f47606673102b91e0295f3a2e0b74b51b4b17852b
- Sigstore transparency entry: 2698205450
- Sigstore integration time: Sep 3, 2026
Source repository:
- Permalink: GBeurier/nirs4all-formats@2d46285843dc366da1d38f133131b5329c886b12
- Branch / Tag: refs/tags/v0.2.8
- Owner: https://github.com/GBeurier
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@2d46285843dc366da1d38f133131b5329c886b12
- Trigger Event: push