osekit 0.2.5__tar.gz

osekit-0.2.5/.github/workflows/documentation.yml

@@ -0,0 +1,42 @@
+name: documentation
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "0.7.8"
+        enable-cache: true
+
+    - name: "Set up Python"
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: "pyproject.toml"
+
+    - name: Install the project
+      run: uv sync --locked --all-extras --dev
+
+    - name: Sphinx build
+      run: uv run sphinx-build docs _site
+
+    - name: Upload Pages artifact
+      uses: actions/upload-pages-artifact@v3
+
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

osekit-0.2.5/.github/workflows/github_ci.yml

@@ -0,0 +1,32 @@
+name: Test package
+
+on: [ push, pull_request ]
+
+jobs:
+  build-linux:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "0.7.8"
+        enable-cache: true
+
+    - name: "Set up Python"
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: "pyproject.toml"
+
+    - name: Install the project
+      run: uv sync --locked --all-extras --dev
+
+    - name: Run tests with coverage
+      run: |
+        uv run coverage run -m pytest
+        uv run coverage report
+
+    - name: Run Ruff
+      run: uv run ruff check --output-format=github --select E4,E7,E9,F

osekit-0.2.5/.gitignore

@@ -0,0 +1,14 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.python-version
+
+# Pycharm stuff
+.idea/

osekit-0.2.5/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+<!--next-version-placeholder-->
+
+## v0.1.0 (10/05/2023)
+
+- First release of OSmOSE
+
+### Features
+
+- Dataset standard build
+- Spectrogram generation
+- Audio file manipulation (reshaping, resampling...)
+- Compatibility with Torque PBS clusters

osekit-0.2.5/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: osekit
+Version: 0.2.5
+Summary: OSEkit
+Author-email: OSmOSE team <osmose@ensta-bretagne.fr>
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: matplotlib>=3.10.3
+Requires-Dist: numpy>=2.2.6
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: pytest>=8.3.5
+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: tomlkit>=0.13.2
+Requires-Dist: tqdm>=4.67.1
+Description-Content-Type: text/markdown
+
+<br>
+<br>
+<div align="center">
+
+<a href="https://github.com/Project-OSmOSE/OSEkit">
+    <img src="docs/logo/osekit.png" alt="OSEkit logo" title="OSEkit" height="120" />
+</a>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+<a href="https://osmose.ifremer.fr/">
+    <img src="docs/logo/osmose_texte_sombre.png" alt="OSmOSE logo" title="OSmOSE" height="120" />
+</a>
+
+<br>
+<br>
+
+![version](https://img.shields.io/badge/package_version-0.2.5-orange)
+![PyPI status](https://img.shields.io/pypi/status/ansicolortags.svg)
+![license](https://img.shields.io/github/license/mashape/apistatus.svg)
+![Open Source Love](https://img.shields.io/badge/open%20source-♡-lightgrey)
+![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)
+
+**OSEkit** is an open source suite of tools written in python and 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 an open source suite of tools written in python and dedicated to the management and analysis of data in underwater passive acoustics. Among other key features, our toolkit has been adapted to be deployed on a cluster infrastructure; in OSmOSE, our production version runs on [DATARMOR](https://www.ifremer.fr/fr/infrastructures-de-recherche/le-supercalculateur-datarmor). Here are a few indications to help you going through our documentation. 
+
+<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/); you will then be redirected to more specific parts of it depending on your profile and intentions:)
+
+<br>
+
+### Acknowledgements
+
+- A great part of our processing codes are based on well-established python packages for data analysis including scipy ,pandas, numpy...
+ 
+# ㅤ
+<sub>© OSmOSE team, 2023-present</sub>
+

osekit-0.2.5/README.md

@@ -0,0 +1,49 @@
+<br>
+<br>
+<div align="center">
+
+<a href="https://github.com/Project-OSmOSE/OSEkit">
+    <img src="docs/logo/osekit.png" alt="OSEkit logo" title="OSEkit" height="120" />
+</a>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+<a href="https://osmose.ifremer.fr/">
+    <img src="docs/logo/osmose_texte_sombre.png" alt="OSmOSE logo" title="OSmOSE" height="120" />
+</a>
+
+<br>
+<br>
+
+![version](https://img.shields.io/badge/package_version-0.2.5-orange)
+![PyPI status](https://img.shields.io/pypi/status/ansicolortags.svg)
+![license](https://img.shields.io/github/license/mashape/apistatus.svg)
+![Open Source Love](https://img.shields.io/badge/open%20source-♡-lightgrey)
+![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)
+
+**OSEkit** is an open source suite of tools written in python and 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 an open source suite of tools written in python and dedicated to the management and analysis of data in underwater passive acoustics. Among other key features, our toolkit has been adapted to be deployed on a cluster infrastructure; in OSmOSE, our production version runs on [DATARMOR](https://www.ifremer.fr/fr/infrastructures-de-recherche/le-supercalculateur-datarmor). Here are a few indications to help you going through our documentation. 
+
+<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/); you will then be redirected to more specific parts of it depending on your profile and intentions:)
+
+<br>
+
+### Acknowledgements
+
+- A great part of our processing codes are based on well-established python packages for data analysis including scipy ,pandas, numpy...
+ 
+# ㅤ
+<sub>© OSmOSE team, 2023-present</sub>
+

osekit-0.2.5/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

osekit-0.2.5/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

osekit-0.2.5/docs/source/_static/audio_data/ex1.svg

@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="75.454269mm"
+   height="74.770668mm"
+   viewBox="0 0 75.454269 74.770668"
+   version="1.1"
+   id="svg1"
+   sodipodi:docname="ex1.svg"
+   inkscape:version="1.4 (86a8ad7, 2024-10-11)"
+   inkscape:export-batch-path="C:\Users\berthoga\Documents\Communications\OSEkit_rework\media\audio_data"
+   inkscape:export-batch-name="ex1"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview1"
+     pagecolor="#505050"
+     bordercolor="#eeeeee"
+     borderopacity="1"
+     inkscape:showpageshadow="0"
+     inkscape:pageopacity="0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#505050"
+     inkscape:document-units="mm"
+     inkscape:zoom="1.4142136"
+     inkscape:cx="544.47222"
+     inkscape:cy="297.3384"
+     inkscape:window-width="1920"
+     inkscape:window-height="1009"
+     inkscape:window-x="-8"
+     inkscape:window-y="-8"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="layer1"
+     showgrid="false">
+    <inkscape:page
+       x="0"
+       y="0"
+       width="75.454269"
+       height="74.770668"
+       id="page3"
+       margin="0"
+       bleed="0"
+       inkscape:label="3" />
+  </sodipodi:namedview>
+  <defs
+     id="defs1" />
+  <g
+     inkscape:label="Calque 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-257.56423,-79.501804)">
+    <g
+       id="g17"
+       transform="translate(170.90854)">
+      <rect
+         style="fill:none;stroke:#e74c3c;stroke-width:0.705001;stroke-linecap:round;stroke-dasharray:none;stroke-opacity:1"
+         id="rect10"
+         width="74.749268"
+         height="17.585871"
+         x="87.008194"
+         y="131.6265"
+         rx="2.7602232"
+         ry="2.7602232" />
+      <rect
+         style="fill:none;stroke:#3498db;stroke-width:0.705;stroke-linecap:round;stroke-dasharray:none;stroke-opacity:1"
+         id="rect11"
+         width="21.742594"
+         height="17.585871"
+         x="87.008194"
+         y="108.0942"
+         rx="2.7602232"
+         ry="2.7602232" />
+      <rect
+         style="fill:none;stroke:#2ecc71;stroke-width:0.705;stroke-linecap:round;stroke-dasharray:none;stroke-opacity:1"
+         id="rect12"
+         width="21.742594"
+         height="17.585871"
+         x="87.008194"
+         y="84.561913"
+         rx="2.7602232"
+         ry="2.7602232" />
+      <path
+         style="fill:#87de87;stroke:#cccccc;stroke-width:0.3;stroke-linecap:round;stroke-dasharray:0.899999, 0.899999;stroke-dashoffset:0"
+         d="M 108.75079,79.651804 V 154.12247"
+         id="path12" />
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.175px;font-family:'Fira Code';-inkscape-font-specification:'Fira Code';text-align:center;writing-mode:lr-tb;direction:ltr;white-space:pre-wrap;shape-inside:url(#rect10);display:inline;fill:#e74c3c;fill-opacity:1;stroke:#d35f5f;stroke-width:0.705001;stroke-linecap:round;stroke-dasharray:none"
+         x="53.788872"
+         y="225.38052"
+         id="text13"><tspan
+           x="120.47511"
+           y="134.40508"
+           id="tspan2"><tspan
+             style="stroke:none;stroke-width:0.705"
+             id="tspan1">FILE</tspan></tspan></text>
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.175px;font-family:'Fira Code';-inkscape-font-specification:'Fira Code';text-align:center;writing-mode:lr-tb;direction:ltr;white-space:pre-wrap;shape-inside:url(#rect11);display:inline;fill:#3498db;fill-opacity:1;stroke:#d35f5f;stroke-width:0.705001;stroke-linecap:round;stroke-dasharray:none"
+         x="53.788872"
+         y="225.38052"
+         id="text15"><tspan
+           x="93.971207"
+           y="110.87187"
+           id="tspan4"><tspan
+             style="stroke:none"
+             id="tspan3">ITEM</tspan></tspan></text>
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.175px;font-family:'Fira Code';-inkscape-font-specification:'Fira Code';text-align:center;writing-mode:lr-tb;direction:ltr;white-space:pre-wrap;shape-inside:url(#rect12);display:inline;fill:#2ecc71;fill-opacity:1;stroke:#d35f5f;stroke-width:0.705001;stroke-linecap:round;stroke-dasharray:none"
+         x="53.788872"
+         y="225.38052"
+         id="text17"><tspan
+           x="93.971207"
+           y="87.340625"
+           id="tspan6"><tspan
+             style="stroke:none"
+             id="tspan5">DATA</tspan></tspan></text>
+    </g>
+  </g>
+</svg>