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

Create a tutorial with an example project with notebooks #50

Open
willingc opened this issue Mar 20, 2023 · 1 comment
Open

Create a tutorial with an example project with notebooks #50

willingc opened this issue Mar 20, 2023 · 1 comment
Labels
good first issue Good for newcomers

Comments

@willingc
Copy link
Contributor

The README.md has a nice example. It would be helpful to provide that example to the user.

@chendaniely
Copy link
Owner

chendaniely commented Mar 20, 2023

I think there are (at least) 2 ways we can address this:

  1. the readme provides code that can create a mock directory and files that the user can explore on their own
  2. we create a separate repository/template that links into the readme that already contains a data/ and analysis/ folder with notebook files in the root and analysis/ folder for people to download and explore on their own
    • We could maybe even set that example repo as a binder instance?
  3. Some combination of the above where we put everything in this repo's examples/ directory

@chendaniely chendaniely added the good first issue Good for newcomers label Mar 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants