Publish outputs to SciCat, and how an output becomes a file

未关闭
#152 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
活跃
技术栈
python
领域
backend, data

调研方向

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_widget for 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
平均合并
9 小时 40 分钟
30 天内合并 PR
60

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

scipp/essapps 的其他 Issue

查看 scipp/essapps 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。