Publish outputs to SciCat, and how an output becomes a file
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
調査の方向性
Read the linked systems and tensions requirements, stories F1 and H3, and issue #151 to understand the publishing requirements and unresolved choices. Inspect the developer README for the client.publish signature and the Store protocol plus testing.FakeStore to see the current storage boundary. The work is done when both callers can publish derived datasets with provenance and file links, and the open format, storage, cleanup, and identity questions are resolved.
索引モデルが issue の本文から書いたものです。
説明
Put an output in SciCat as a derived dataset, with its provenance as metadata and a link to a written file.
Required by: the Goal ("upload them to SciCat"), "batch reduction must put its results into SciCat, or at least let users do so" (systems), and stories F1 and H3. Only results in SciCat are found later, and the first release has no connect(), so SciCat is also how users find the results of automatic reduction (#151).
Two callers
- The batch application, when a person chooses, likely with
scicat_widgetfor the UI. - The automatic-reduction service, with no frontend open.
Proposal
A library function that both call, which reads the output and its provenance through the client:
pid = publish(client, record.ref('iofq'), scicat)
So the backend gains no publisher, and client.publish (signature only, in the developer README) goes away.
How an output becomes a file
SciCat holds metadata and file paths, not the files, so a published output needs a file in a known format at a path. The Store protocol has only write and read by record ID and output name, and leaves the format and the layout to the store. Its only implementation is testing.FakeStore.
To decide:
- the format per output type;
- the layout on disk, and where a file must be for SciCat to link to it;
- whether publishing reads the store's file or writes a file of its own;
- how files are dropped by proposal, label, or age (H1), given that a published dataset stays after the history is dropped.
No wire format is needed for the first release. A later transport may share the format.
Open requirement questions
- May the service create datasets for a proposal, and who may delete them (systems, Open)?
- Do results reach SciCat automatically, or only when a person chooses (tensions, Open)?
- How does a user's SciCat token reach the batch application, and which identity does the service use?
- Software versions in the provenance (
provenance.software, F2).
- 主要言語
- Python
- スター
- 0
- フォーク
- 1
- 平均マージ
- 15時間 40分
- マージ済み PR（30日）
- 59
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
scipp/essapps のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
A number that is not finite is stored as None at a field that accepts None対応中かも @jeevanabhi-r が 2 日前に担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
scipp/essapps#140 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 40/100
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
docs size:S
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
strawberry-graphql/strawberry#4794 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
dataforgoodfr/cetolog#21 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
btclib-org/btclib#2932 ·
メンテナーはふだん 1 日以内に返信