Releases: Project-OSmOSE/OSEkit
v0.4.2b1
What's Changed
- No strptime format by @Gautzilla in #306
- handle boolean flag for pbs files by @mathieudpnt in #303
Full Changelog: v0.4.1...v0.4.2b1
v0.4.1
What's Changed
Not much: JSON files now specify relative paths, relative to the JSON file parent folder @Gautzilla in #308
Full Changelog: v0.4.0...v0.4.1
v0.4.0
🐳 What's Changed??
🐬Main new things
- Job rework by @Gautzilla in #281
- Data overlap by @Gautzilla in #297
- Optional normalization passing by @Gautzilla in #289
- add intermediate SpectroDataset.get_welch method by @Gautzilla in #300
🐬Bug fixes
- [FIX] RAM leak by @Gautzilla in #287
- [FIX] Spectral analysis linked to existing audio analysis by @Gautzilla in #296
- Fix/sd split instrument and normalization by @Gautzilla in #280
- fix a typo in the custom frequency scale doc by @Gautzilla in #299
🐬Back/Other
- add Event repr dunder by @Gautzilla in #284
- upgrade dependencies by @Gautzilla in #290
- change plot backend to imshow by @Gautzilla in #291
- SpectroDataset scale by @Gautzilla in #293
- update actions by @Gautzilla in #294
Full Changelog: v0.3.1...v0.4.0
v0.3.1
What's Changed
- Fix aplose2raven by @MaelleTtrt in #263
- Fix logger by @mathieudpnt in #274
- The logger is no longer automatically configured. See PR for more info.
- Analysis overwrite protection by @Gautzilla in #276
- Public API analyses can now be renamed and deleted.
- Running an analysis that has the name of an already-existing analysis will now raise an error. See PR for more info.
- Audio normalization by @Gautzilla in #268
- Audio data can now be normalized according to several normalization functions. See PR for more info.
Full Changelog: v0.3.0...v0.3.1
v0.3.0
What's Changed
This version cleans out the legacy OSEkit remains (the job module is the last one that must be reworked). Moreover:
- Core API by @Gautzilla in #245
- Feature/timezone management by @Gautzilla in #251
- [Optimization] Event overlap by @Gautzilla in #257
- Feature/strptime format list by @Gautzilla in #258
- [FEATURE] resample quality setting by @Gautzilla in #260
- New osmose logo by @Gautzilla in #262
- Feature/public api by @Gautzilla in #256
- Public LTAS by @Gautzilla in #265
Full Changelog: v0.2.5...v0.3.0
v0.2.5
What's Changed
Mostly backend stuff. The only change affecting the user interface is explained here.
- fix display storage core function by @mathieudpnt in #230
- delete out and pbs files on initialize by @Gautzilla in #232
- integration of timestamp utils by @Gautzilla in #216
- Refactor/timestamp utils integration by @Gautzilla in #236
- Revert "integration of timestamp utils (#216)" by @Gautzilla in #235
- remove umask calls by @Gautzilla in #234
- more explicit build warning messages by @Gautzilla in #238
- fix dtype in Dataset.py by @mathieudpnt in #239
- patch to 0.2.5 by @Gautzilla in #240
Full Changelog: v0.2.4...v0.2.5
v0.2.4
Compatibility with 0.2.3
Imports should now decribe the full path to the asset to import:
# worked in 0.2.3 but won't work in 0.2.4
from OSmOSE.utils import display_folder_storage_info
# works in 0.2.4 (and in 0.2.3)
from OSmOSE.utils.core_utils import display_folder_storage_infoAdded Features
log system by @Gautzilla in #220
OSEkit now uses a proper logging system. Its default configuration is stored in the logging_config.yaml file.
For working with a custom configuation, users should duplicate this file into their current working directory. OSEkit will use the logging_config.yaml present in the current working directory, if any, over the one present in the source code.
More info about the logging system in #220.
better timestamps managing by @Gautzilla in #210
Utility functions were added to simplify the use of timestamps within OSEkit. This is just a first step, as it hasn't been fully implemented through the whole codebase. At the moment, the changes are:
Timestamp filtering for spectrogram generation:
On the datarmor toolkit, specifying the datetime_begin and datetime_end paremeters of the generate_spectro function with an already-initialized dataset will generate spectrogram images only for the audio files that are included in the timestamps.
strftime code extraction:
Users might now be able to specify complex strftime codes for extracting timestamps from their audio file names:
# With audio files named "recordingdevice_2024_11_26_123456.wav" and "recordingdevice_2024_11_27_123456.wav"
dataset.build(date_template="%Y_%m_%d_%H%M%S") # Timestamps 2024-11-26 12:34:56 and 2024-11-27 12:34:56 will be correctly parsedTimezone management:
Timezones can either be parsed from the audio file names (thanks to the %z and %Z codes) or specified as a parameter to the Dataset.build() method. If different timezones are parsed from the file names and passed to the Dataset.build() method, the timestamps will be converted from the timezone parsed from the names to the timezone passed as a parameter:
# audio file "recordingdevice_2024_11_26_123456+0100.wav"
dataset.build(date_template="%Y_%m_%d_%H%M%S", timezone="+0200")
# The timestamp associated with the audio file will be 2024-11-26 13:34:56+02:00Raven formatting utils by @mathieudpnt in #213
Add the OSmOSE.utils.formatting_utils.aplose2raven function that converts an APLOSE-formatted result DataFrame to a Raven-formatted result DataFrame.
The resulting Raven DataFrame can then be exported to a csv file and loaded into Raven.
Bug Fixes
check permissions before chmod by @Gautzilla in #212
Running OSEkit in folder of which the user doesn't have the rights to edit the permissions should no longer raise an error.
Full Changelog
v0.2.3
What's Changed
- The
Spectrogramclass can now be initialized from themetadata.csvfile that contains its attributes. - The spectrogram generation from Datarmor (using
generate_spectroon the toolkit) can now be done on already-reshaped audio files without having to callspectrogram.initalize()
Full Changelog: v0.2.2...v0.2.3
v0.2.2
Release 18/07/2024
v0.2.1 Add files via upload (#131)