pycroscopy / pycroscopy/sidpy

Abstract class for writing sidpy.Dataset to file

Open
#90 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We have / will have functions in pyUSID and pyNSID to write Dataset objects to HDF5. Should we define an abstract Writer class for such an operation? Do we anticipate alternate modes of output in the future?

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

Review the existing Dataset-to-HDF5 writing functions in pyUSID and pyNSID, which are the issue's named entry points; no files or tests are specified. Determine whether a shared abstract Writer should support current and anticipated alternate output modes, and document the chosen design and its completion criteria.

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.