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

Document what we know about the Jupyter notebooks #15

Open
patrickmj opened this issue Jun 5, 2023 · 0 comments
Open

Document what we know about the Jupyter notebooks #15

patrickmj opened this issue Jun 5, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation Immediately actionable wrapup task

Comments

@patrickmj
Copy link
Collaborator

patrickmj commented Jun 5, 2023

For each notebook, document in a README the following:

  • Description of what it does
    • general description of the input and output
    • a sense of its purpose: what does it make visible, or what basic task does it accomplish?
  • What input files are required to use it
  • Any questions about how it works or anything that requires some in-depth explanation

A template is in the Jupyter_Notebooks directory.

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 Immediately actionable wrapup task
Projects
None yet
Development

No branches or pull requests

2 participants