Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

napari-sediment

License BSD-3 PyPI Python Version tests codecov napari hub

This napari plugin is designed to hyper-spectral images of sediment cores. It is composed of three interfaces allowing the user to:

  • import HDR images
  • normalize the images using white and dark references
  • mask unwanted regions
  • perform spectral dimensionality reduction via minimum noise fraction analysis
  • perform spatial dimensionality reduction based on pixel purity indices
  • identify representative end-members by clustering pure pixels
  • select relevant regions in spectra to compute absorption indices and create absorption maps

Pre-processing: Sediment widget

The sediment widget allows the user to import an HDR image and to normalize it using white and dark references. The widget also allows the user to mask unwanted regions of the images.

Documentation

You can find a detailed documentation here.

Installation

Conda Environment

Installation instructions used to recommend creating an environment and installing napari via conda and then the plugin via pip. This often leads to issues with overlapping dependencies (tpyically with libopenblas or other low-level libraries) and to the plugin crashing. The newest environment setup avoids these issues by installing napari and the plugin entirely via pip within a clean conda environment.

Create a conda environment and activate it. If you don't have conda installed you can for example install miniforge.

conda create -n sediment python=3.13
conda activate sediment

Then you can install napari and napari-sediment use:

pip install "napari[all]" napari-sediment

Or you can install the latest development version directly from the GitHub repository:

pip install git+https://github.com/guiwitz/napari-sediment.git

uv installation

To create an environment using uv, create a project folder and add napari and napari-sediment to it:

uv init sediment --python 3.13
cd sediment
uv add "napari[all]" napari-sediment

To instead get the latest development version from the main branch on GitHub, replace the last command with:

uv add "napari[all]" "git+https://github.com/guiwitz/napari-sediment@main"

To later update to the newest commit on main, run uv lock --upgrade-package napari-sediment followed by uv sync.

You can then start napari from within that folder with:

uv run napari

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, "napari-sediment" is free and open source software

Authors

This plugin has been developed by Guillaume Witz at the Data Science Lab of the University of Bern in collaboration with Petra Zahajská, Institue of Geography of the University of Bern. Funding for development was provided by Prof. Martin Grosjean, Institute of Geography of the University of Bern.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Metadata

Release files for napari-sediment 0.6.0rc0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for napari-sediment 0.6.0rc0
File Size Uploaded Provenance Actions
napari_sediment-0.6.0rc0.tar.gz 24.5 MB With provenance Details for napari_sediment-0.6.0rc0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for napari-sediment 0.6.0rc0
File Interpreter ABI Platform Actions
napari_sediment-0.6.0rc0-py3-none-any.whl Python 3 none any Details for napari_sediment-0.6.0rc0-py3-none-any.whl

Total release size: 24.6 MB

Release files / napari_sediment-0.6.0rc0.tar.gz

Download URL napari_sediment-0.6.0rc0.tar.gz
Size 24.5 MB
Tags Source
SHA-256 checksum
How to use checksums
5b017b8ff27838ad913f0b4f4f92794c6c6fdac2f90178e787483c52480ec6a6
BLAKE2b-256 checksum
How to use checksums
e04826ec4d1f48dc078e34dcbaf267ab1788643135116faa6b55f420c20fd78d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Release files / napari_sediment-0.6.0rc0-py3-none-any.whl

Download URL napari_sediment-0.6.0rc0-py3-none-any.whl
Size 126.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f99e09d4af56e711e2b90b2abc2ea559f42290bea8f218588414e60eefa74aec
BLAKE2b-256 checksum
How to use checksums
5ab435ba04dd21f294c5fe263cc6efd8f88233605572f71e5ef09ec1bf3cf49f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Security for napari-sediment 0.6.0rc0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for napari_sediment-0.6.0rc0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page