CLI reports.h5: sedmlDataSetShapes per job, and Y curves labelled ::X

Open
#2,192 3 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
java
Domain
cli, data

Research direction

Start in vcell-cli/src/main/java/org/vcell/cli/run/results/NonSpatialResultsConverter.java around line 170, where one shapes list is shared across data sets and each job's flat size is appended. Then check the label format strings in ResultsConverter.java at lines 84 and 93, and the comment above add2DPlotsAsReports in prepareNonSpatialDataForHdf5. Done means one comma-joined shape per data set, curve data sets labelled without the ::X suffix, and the comment matching the BioSimulators-mode condition. Confirm the output still matches the legacy writer's expected reports.h5 on the UnifiedDataModel branch, since the issue asks for both changes to be deliberate.

Written by the indexing model from the issue text.

Description

Summary

Two places where the CLI's reports.h5 deviates from the BioSimulators conventions. Both are intentionally reproduced, for now, by the new data system on the UnifiedDataModel branch so its output can be checked byte-for-byte against the legacy writer. Fix them deliberately, in both places.

1. sedmlDataSetShapes has one entry per data set per job. NonSpatialResultsConverter.java:170 shares one shapes list across all data sets and appends each job's flat size to it. A 3-data-set report over a 3-value scan gets 9 entries such as "21", where the convention is one comma-joined shape per data set.

2. Plots reported as reports label every curve data set <plot>.<curve>::X. That includes the Y data generators: ResultsConverter.java:84 and line 93 use the same format string.

Related, minor: the comment above add2DPlotsAsReports in prepareNonSpatialDataForHdf5 says plots are added when not in BioSimulators mode, but the code adds them only in BioSimulators mode.

Dominant language
Java
Stars
140
Forks
35
Avg merge
17h 39m
Merged PRs (30d)
19

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from virtualcell/vcell

All issues in virtualcell/vcell

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.