NSLS2 / NSLS2/pyCHX

where should functions that save XPCS / speckle results go?

Open
#57 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

_commonspeckle _futurepyCHX discussion
Dominant language
Jupyter Notebook
Stars
8
Forks
12
Avg merge
2h 53m
Merged PRs (30d)
6

Description

If in _common/speckle, then we would have pressure/expectation of saving as nexus file that will be estabilished.

It also seems like things are save as .csv as an interim solution and then all data saved in a .h5 file at the end. I imagine this is for computation that fails. Should we look in to "appending" to the .h5 file? @danielballan is this possible?

What havens to the .csv files once there is a master .h5 file?

Contributor guide

Open the contributing guide

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.

Research direction

No files, tests, or entry points are named. Start by locating the existing functions that write speckle or XPCS results to CSV and H5 files, then determine the intended ownership and lifecycle of those outputs. Done means the repository has a decided location and documented behavior for appending to H5 files and handling interim CSV files.

Written by the indexing model from the issue text.

Assessment

Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.