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

Add an "about" file describing this repo's origins from the original ORNL DAAC notebook that inspired it #46

Open
chuckwondo opened this issue Jul 21, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@chuckwondo
Copy link
Collaborator

chuckwondo commented Jul 21, 2023

Add an ABOUT.md or an ABOUT.ipynb file, describing the impetus for this project, specifically starting with the ORNL DAAC code in sections 4b and 4c of the 2_gedi_l4a_subsets.ipynb notebook.

To aid in comparing our code with the original notebook code, we should refer to the corresponding parts in our code, particularly the H5DataFrame class and the subset_hdf5 function (to avoid requiring the reader to sift through the code that's not relevant for comparison, such as our CLI code), and ideally this "about" file should include code snippets using our code (not necessarily via submitting a DPS) to achieve the same results (or very nearly so) as shown in the original notebook.

If an ABOUT.ipynb is created, that might be the best way to construct a "side-by-side" comparison between the code in this repo and the ORNL DAAC notebook.

@chuckwondo chuckwondo added the documentation Improvements or additions to documentation label Jul 21, 2023
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
Projects
None yet
Development

No branches or pull requests

1 participant