Skip to content

_dashboarding #19

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

Open
2 of 4 tasks
nicole-brewer opened this issue Jun 28, 2023 · 6 comments
Open
2 of 4 tasks

_dashboarding #19

nicole-brewer opened this issue Jun 28, 2023 · 6 comments

Comments

@nicole-brewer
Copy link
Collaborator

nicole-brewer commented Jun 28, 2023

It occurred to me that I should import a preview of the end goal at each step. So that it is clear what we are working toward at every step. I want to have two tables of contents. One that makes clear the concrete goal we are trying to achieve and another that lays out the learning steps we do along the way.

  • Rough draft for ASU tutorial
  • add exports
  • Create headings/toc for each "checkpoint"
  • Create headings/toc for learning goal

Note: it would be good if there was only one example of observe and whatever other skill were covered in 01_getting_started

@nicole-brewer nicole-brewer mentioned this issue Jun 28, 2023
4 tasks
@nicole-brewer
Copy link
Collaborator Author

The more and more I think about this, the more it makes sense to introduce nbdev at the beginning of the tutorial. It gives people more time to get comfortable using it, and it also makes it so I don't have to write so much tutorial code for the "checkpoints". The problem is, I need to try this out without it getting too messy. Maybe the trick is to stash my current changes, then try the new organization, and then reintroduce the stashed changes.

Organization

  • Update settings.ini so that the the notebooks jupyter_web_app_template are in web_nbs/ instead of nbs/
  • For the dashboard stuff, it could be dashboard_nbs and dashboard. But it could also be in . instead of it's own folder so the progression of most tutorial notebooks are in the base directory. Not sure what the best choice is there. Is there a problem when base directory notebooks do not contribute to the library? I need to look that up before deciding. If it is an issue, best to just avoid the time sink. If not though, it may be good to demonstrate that the nbs can be in the root or a folder? Well, there will need to be more than one settings.init. The one for web_app will need to be in the web_app dir, which is the root. So if I wanted to demonstrate the notebooks being in another folder instead of the root, I would need to put dashboard_nbs in their own folder but leave settings.ini in the root. But maybe it's best to be modular to avoid confusion. I'm unsure.

Introducing nbdev earlier makes more and more sense to me. Would I encourage someone to use nbdev, even if they weren't working on a full-blooded oop web app? Yes. So let's introduce that earlier on.

@nicole-brewer nicole-brewer mentioned this issue Jul 4, 2023
4 tasks
@nicole-brewer
Copy link
Collaborator Author

Creating a new issue for the reorg attempt #20

@nicole-brewer
Copy link
Collaborator Author

Okay, so as explained in #20, I don't need to do a full reorg. But that did inspire some changes that I'd still like to accomplish about GitHub actions, so I changed the title of that issue.

I am also going to change my checklist above to include what I discovered in the meantime; mainly that I can use nb_export to turn the dashboarding notebook into a dashboard without having to do that manually.

@nicole-brewer
Copy link
Collaborator Author

nicole-brewer commented Jul 4, 2023

To introduce nbdev right, I have to work from a little further back. I need to add "Benefits of Jupyter and JuptyerLab" to 01_getting_started.ipynb (#21)

@nicole-brewer nicole-brewer added this to the complete tutorial milestone Jul 5, 2023
@nicole-brewer
Copy link
Collaborator Author

I did have "Add basic layout with HBox" on the to do list, but I think that Layouts can be it's own notebook. We can take the exported code and arrange it in another notebook.

@nicole-brewer nicole-brewer changed the title 04_dashboarding 03_dashboarding Jul 6, 2023
@nicole-brewer nicole-brewer changed the title 03_dashboarding _dashboarding Jul 6, 2023
@nicole-brewer
Copy link
Collaborator Author

Finished adding exports in 0b41dd2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant