Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Dealing with the various version of the Febus Format #19

Merged
merged 9 commits into from
Sep 18, 2024

Conversation

atrabattoni
Copy link
Contributor

@atrabattoni atrabattoni commented Sep 18, 2024

Because the Febus format version history is undocumented, we encorage to manually set the trimming and timing strategy when reading Febus file.

Add:

  • Possibility to pass engine kwargs to all xdas.open_* functions.
  • overlaps and offset kwargs to read function of xdas.io.febus. Warn if kwargs not passed.
  • Some documentation in the Data Formats section.

Example:

xdas.open_dataarray("path.h5", engine="febus", overlaps=(100, 100), offset=1000)

When we will be sure about this function, we will remove the warnings.

@atrabattoni atrabattoni added the bug Something isn't working label Sep 18, 2024
@atrabattoni atrabattoni self-assigned this Sep 18, 2024
Copy link
Contributor Author

@atrabattoni atrabattoni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ClaudioStrumia Could you test that branch on real data to validate it. Also could you check the by default trimming and try to propose something that should work in most cases.

Copy link

codecov bot commented Sep 18, 2024

Codecov Report

Attention: Patch coverage is 14.70588% with 29 lines in your changes missing coverage. Please review.

Project coverage is 85.31%. Comparing base (0249f19) to head (c6b0f35).
Report is 10 commits behind head on dev.

Files with missing lines Patch % Lines
xdas/io/febus.py 6.89% 27 Missing ⚠️
xdas/core/routines.py 60.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              dev      #19      +/-   ##
==========================================
- Coverage   85.89%   85.31%   -0.59%     
==========================================
  Files          28       28              
  Lines        3312     3336      +24     
==========================================
+ Hits         2845     2846       +1     
- Misses        467      490      +23     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@atrabattoni atrabattoni merged commit 88fe71c into dev Sep 18, 2024
4 checks passed
@atrabattoni atrabattoni deleted the fix/febus-overlap branch September 18, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants