pycroscopy / pycroscopy/sidpy

Tracking HDF5 dataset object(s) that make up a Dataset object

Open
#33 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs discussion question
Dominant language
Jupyter Notebook
Stars
12
Forks
18
PR merge metrics
No merged PRs in 30d

Description

It would be great if the Dataset object could track if a given sidpy.Dataset object has a HDF5 counterpart or not and where one could get it. This way one would know whether and where this Dataset object exists in a file.

The one obvious problem is that x = x + 1 would likely break things since x is no longer the same object that exists in HDF5. We would need to track the state of the Dataset object.

Contributor guide

No contributing guide indexed for this repository

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

Start by examining the sidpy.Dataset object and how it relates to an HDF5 counterpart. Clarify how an object should report whether and where it exists in a file, including what happens after operations such as x = x + 1. Done requires an agreed tracking model and documented behavior for object state changes.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.