Gaps found by the Panel outputs prototype

Đang mở
  • Có gì không ổn?
#124 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
jupyter, python
Lĩnh vực
data-visualization, developer-experience

Hướng nghiên cứu

Start with docs/developer/roles/spec-form.ipynb on the spec-form-outputs branch and inspect the five gaps recorded in the issue. The issue says the prototype works around them and identifies #81 for the completion notification; first determine which gap is in scope. Done means addressing a selected gap, with the prototype behavior improved as described.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Gaps found while adding an outputs list and plotting to the Panel prototype (docs/developer/roles/spec-form.ipynb, branch spec-form-outputs). The app lists a row per output of each record, shows what the output is and how it was made, and plots arrays with plopp. None of these block the prototype.

1. A value's summary reads the whole value (moved to #149)

To show an output's sizes, unit and coordinates, the app calls client.output(record, name), which copies the whole value. No call returns this without the data:

value = client.output(record, 'counts')  # copies the whole array
f'{value.dims} {value.shape} [{value.unit}]'

In this process the cost is small. For the hosted service (#27), listing or inspecting outputs would transfer every value.

2. The spec doesn't declare an array's number of dimensions (moved to #149)

The spec declares sc.Variable or sc.DataArray, but not how many dimensions. ForwardOutputs.i0 is declared as an array, so the app offers Plot, but its value is 0-D. The app only finds out after reading it and shows "0-D, not plotted". The same holds for arrays with more than 2 dimensions.

3. Nothing tells the app that a record finished (moved to #148)

The app submits without waiting, then polls client.status every 0.5 s through a Panel periodic callback (App.poll). The missing as_completed / timeout= is already listed in #81. In the prototype, each finished record also rebuilds the pickers of every form, since a form offers each record as a reference.

4. A workflow can't learn a run's number from its file model

A file's identity is opaque to the workflow. toy_sans.COUNTS outputs a (run, pixel) array, but cannot give the run dimension a coordinate with the run numbers, so the plot labels runs by index.

5. Default titles from field names read poorly

places.title turns iofq into "Iofq". The spec author can set Field(title=...), so this needs nothing from the framework, but the toy specs and examples should set titles (and description=) on outputs.

Ngôn ngữ chính
Python
Star
0
Fork
1
Merge trung bình
15 giờ 40 phút
Pull request đã merge (30 ngày)
59

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của scipp/essapps

Tất cả issue của scipp/essapps

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.