Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

BrukerTimsFile: read .d.zip archives without unpacking analysis.tdf_bin

オープン
#10,281 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
cpp, sqlite
領域
data

調査の方向性

Start with src/openms/source/FORMAT/BrukerTimsFile.cpp, especially unpack_ and openTimsDataHandle, then review ZipArchiveFile and the opentims v1.2.0b4 API referenced by cmake/cmake_findExternalLibs.cmake. Compare stored and deflated entries in the #10273 behavior; done means stored .d.zip archives avoid copying analysis.tdf_bin, deflated entries retain extraction, and the supported behavior is documented.

索引モデルが issue の本文から書いたものです。

説明

enhancement
Enhancement Description

#10273 lets FileConverter and BrukerTimsFile read Bruker .d.zip archives. They unpack the archive into the temporary directory first, with a free-space budget and path checks. For a long timsTOF run, that copies the whole analysis.tdf_bin, often several GB, to disk before a single frame is read. Reading the archive in place would save both the temporary disk space and the extraction time.

Constraints

  • opentims opens analysis.tdf_bin from a file path. TimsDataHandle memory-maps it (mio::mmap_source tims_data_bin) and reads each frame at its offset, and every public constructor takes paths.
    • OpenMS fetches opentims from michalsta/opentims v1.2.0b4 (cmake/cmake_findExternalLibs.cmake) or uses a system installation, so an API change belongs upstream.
  • SQLite needs analysis.tdf as a file. It is small: 12 MB in our test data.
  • Random access into a deflated ZIP entry needs decompression. In the test archive DDA_HeLa_50ng_5_6min.d.zip, analysis.tdf_bin is deflated: 366 MB become 358 MB. The frames are already zstd-compressed, so deflate saves only about 2%.

Proposal

  1. Stored entries (zip -0):
    • Extract only analysis.tdf.
    • Memory-map the ZIP file and give opentims the byte range of analysis.tdf_bin, so the bulk data is never copied.
    • This needs an opentims constructor that takes a mapped buffer, or a (path, offset, length).
  2. Deflated entries:
    • Keep unpacking to disk, which is the behaviour of #10273.
    • Decompressing into memory instead would trade the temporary disk space for the same amount of RAM, so it should at most be an option.
  3. Documentation: say that .d.zip archives written with zip -0 are read without extraction.

References

主要言語
C++
スター
623
フォーク
441
平均マージ
18時間 15分
マージ済み PR(30日)
255

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenMS/OpenMS のほかの issue

OpenMS/OpenMS の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。