Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example on how one would use a Reader class #3

Closed
ssomnath opened this issue Sep 10, 2020 · 1 comment · Fixed by #2 or #16
Closed

Example on how one would use a Reader class #3

ssomnath opened this issue Sep 10, 2020 · 1 comment · Fixed by #2 or #16
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed urgent

Comments

@ssomnath
Copy link
Member

This example should show how a user would go about using a Reader class:

  1. First pick the appropriate Reader class. We can replace this manual step with a read() function which would automatically find which Reader to use
  2. Then, pass the file to instantiate the Reader object
  3. Call the my_reader.read() function to get back one or more sidpy.Dataset objects
  4. Show the user that this sidpy.Dataset object has the following:
    1. Raw data - by visualizing the data
    2. Metadata
  5. How how the user could optionally use pyNSID or pyUSID to write the sidpy.Dataset object(s) to HDF5 if the user wanted to exchange information with other researchers.
    1. Show the tree structure within the HDF5 file showing where the data has been written to. No need to visualize again.
    2. Show that the metadata too has been safely captured
    3. Show that any ancillary dataset(s) have also been written to HDF5
@ssomnath ssomnath added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Sep 10, 2020
@ssomnath ssomnath linked a pull request Sep 11, 2020 that will close this issue
@ssomnath
Copy link
Member Author

@gduscher - You have largely addressed this issue with your last pull request #2. Awesome job! I think that only a handful of things are necessary to complete this example. We want this example to be fully self contained. Provide a small dm3 file in a data folder of this repository for demonstration, instead of expecting the user to provide a file. You can certainly make a note that the users should replace the file path or use the pyQt5 file opener (present in sidpy) to open their own dm3 files. Also in general, avoid file interface functions in these examples, since these are not interactive.

Do let me know if you have any questions

@ssomnath ssomnath linked a pull request Dec 11, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed urgent
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants