Skip to content

Allow explicit selection of compression option and add benchmark result in the documentation page.#189

Merged
YooSunYoung merged 5 commits intomainfrom
compression
Jan 22, 2026
Merged

Allow explicit selection of compression option and add benchmark result in the documentation page.#189
YooSunYoung merged 5 commits intomainfrom
compression

Conversation

@YooSunYoung
Copy link
Copy Markdown
Member

@YooSunYoung YooSunYoung commented Jan 21, 2026

Fixes scipp/ess#199

The notebook for the benchmark was shared in the nmx slack channel... I didn't think it was necessary to store it somewhere...

@github-project-automation github-project-automation Bot moved this to In progress in Development Board Jan 21, 2026
@YooSunYoung YooSunYoung moved this from In progress to Selected in Development Board Jan 21, 2026
Copy link
Copy Markdown
Member

@SimonHeybrock SimonHeybrock left a comment

Choose a reason for hiding this comment

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

No tests, or just no test changes necessary because there are existing ones?

@YooSunYoung
Copy link
Copy Markdown
Member Author

No tests, or just no test changes necessary because there are existing ones?

There are some tests related to the compression options but I'll add more tests to see if it actually compress the dataset.

Comment thread tests/executable_test.py
Comment on lines +492 to +496
@pytest.mark.skipif(
BITSHUFFLE_AVAILABLE,
reason="Bitshuffle is available in this environment so it won't fall back.",
)
def test_reduction_compression_bitshuffle_fall_back_to_gzip(
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This test will be skipped on our CI but I tested on my local machine (mac) and it worked.

@YooSunYoung
Copy link
Copy Markdown
Member Author

@SimonHeybrock I added some tests. will you have a look again?

Comment thread tests/executable_test.py
Comment on lines +432 to +444
try:
# Just checking availability
import bitshuffle.h5 # noqa: F401
except ImportError:
BITSHUFFLE_AVAILABLE = False
else:
BITSHUFFLE_AVAILABLE = True


@pytest.mark.skipif(
not BITSHUFFLE_AVAILABLE,
reason="Bitshuffle is not available in this environment.",
)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yeah but we have another test that is skipped if it IS available.
It looks like importorskip skips the test only if the module is not avaiable.

@YooSunYoung YooSunYoung merged commit 520582d into main Jan 22, 2026
4 checks passed
@YooSunYoung YooSunYoung deleted the compression branch January 22, 2026 12:24
@github-project-automation github-project-automation Bot moved this from Selected to Done in Development Board Jan 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Explicitly select compression option in the data reduction call.

2 participants