Save Experiment object as HDF5 File

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
活発
領域
data

調査の方向性

まず Experiment オブジェクトと既存の all_scansnos の動作を見つけ、次にスキャンファイルとリンクされた検出器データがどのように表現されているかを確認します。実装する前に、保存される実験エントリ、スキャンリンク、コピーオプション、デフォルトプロット、および Experiment.save/load の動作を定義します。完了条件には、load が all_scansnos() より高速かどうかの確認も含まれます。

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

説明

Add a function to the Experiment object that will save the object as a HDF5 File.

The file should contain:

  • Experiment entry (default), including:
    • folder name(s)
    • config
    • scan list
    • start, end time
    • instrument info?
    • Default Plot - scan number vs scan time? (This might take a while as it requires reading each file)
  • Links to the entry of every scan in the experiment

In addition, there should be an option to copy all the scans into a single file, and the additional option to copy all the linked data (detector data). This should probably use lossless compression if not already used.

Opening the file

There should also be a file reader, as an optional input to Experiment.

I would expect that it will be faster to read the scan list from the file than reading the file-system, but this should be checked.

Tasks

  • Create Experiment.save
  • Define experiment entry in saved file
  • Define default plot in experiment entry
  • include links to scan files
  • option to copy scan file contents
  • option to copy linked file contents
  • Create Experiment.load
  • Check that Experiment.load() is faster than Experiment.all_scansnos()
主要言語
Jupyter Notebook
スター
2
フォーク
0
平均マージ
17分
マージ済み PR(30日)
4

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

DiamondLightSource/mmg_toolbox のほかの issue

DiamondLightSource/mmg_toolbox の issue をすべて見る

似ている issue

Data Engineering の issue をもっと見る

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

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