Metadata-Version: 2.4
Name: osekit
Version: 1.0.1
Summary: OSEkit
Author-email: OSmOSE team <osmose@ensta-bretagne.fr>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.12
Requires-Dist: matplotlib>=3.10.7
Requires-Dist: notebook>=7.4.4
Requires-Dist: numpy>=2.2.6
Requires-Dist: pandas>=2.2.3
Requires-Dist: pytest>=8.3.5
Requires-Dist: pytz>=2025.2
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: scipy>=1.15.3
Requires-Dist: soundfile>=0.13.1
Requires-Dist: soxr>=0.5.0.post1
Requires-Dist: tqdm>=4.67.1
Provides-Extra: mseed
Requires-Dist: obspy; extra == 'mseed'
Description-Content-Type: text/markdown

<br>
<br>
<div align="center">

[![OSEkit logo](https://raw.githubusercontent.com/Project-OSmOSE/OSEkit/refs/heads/main/docs/logo/osekit_mid.png)](https://github.com/Project-OSmOSE/OSEkit)

<br>
<br>

![version](https://img.shields.io/pypi/v/osekit?label=osekit)
![PyPI status](https://img.shields.io/pypi/status/osekit)
[![Coverage Status](https://coveralls.io/repos/github/Project-OSmOSE/OSEkit/badge.svg?branch=version-bump)](https://coveralls.io/github/Project-OSmOSE/OSEkit?branch=version-bump)
![license](https://img.shields.io/github/license/mashape/apistatus.svg)
![Open Source Love](https://img.shields.io/badge/open%20source-♡-lightgrey)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18337275.svg)](https://doi.org/10.5281/zenodo.18337275)
![Python 3.12](https://img.shields.io/pypi/pyversions/osekit)


**OSEkit** is an open source python package dedicated to the management and analysis of data in underwater passive acoustics.

[Presentation](#presentation) •
[Getting into it](#getting-into-it) •
[Acknowledgements](#acknowledgements)
# ㅤ

</div>

### Presentation

**OSEkit** is a Python open source package designed for effortless manipulation of audio data.

It is primarily designed for working on underwater passive acoustics data, but can be used on any audio data.

**OSEkit** provides:

- Seamless, timestamp-based access across multiple files (e.g., pick a 3-minutes long segment spannign over two 1.5-minutes long files without manual file picking)
- Preprocessing utilities: resampling, normalization...
- Spectral analysis routines: compute power spectra, spectrograms, LTAS...
- A high-level **API** designed to work with [APLOSE](https://github.com/Project-OSmOSE/APLOSE), our web-base spectrogram annotation tool

**OSEkit** treats your audio dataset as a continuous timeline, whatever the raw files configuration.
You request audio by time intervals and the package fetches from the raw files behind the scenes: no manual I/O juggling required.

<br>

### Getting into it

All details to start using our toolkit and make the most out of it are given in our [documentation](https://project-osmose.github.io/OSEkit/).


This software is distributed under the MIT license.

You are free to use, modify, and redistribute it, provided that you retain the copyright
notices and license text, in accordance with the terms of this license.

See the [LICENSE](./LICENSE) file for the full text.

Some third-party libraries are used in this project. Details of their licenses are
available in the repository [dependency graph](https://github.com/Project-OSmOSE/OSEkit/network/dependencies).

This software must not be sold.

If you use this software in scientific work, please cite it in accordance with the
[CITATION](./CITATION.cff) file.

This software is provided for research and teaching purposes. It is provided “as is,”
without warranty. The authors and the institution cannot be held responsible for any
damage resulting from its use.

<br>

<div align="center">

[![OSmOSE logo](https://raw.githubusercontent.com/Project-OSmOSE/OSEkit/refs/heads/main/docs/logo/osmose_texte_sombre_small.png)](https://osmose.ifremer.fr/)

</div>

<br>

<sub>© OSmOSE team, 2023-present</sub>
