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

Improve notebooks organization #33

Closed
Adafede opened this issue Oct 21, 2024 · 3 comments
Closed

Improve notebooks organization #33

Adafede opened this issue Oct 21, 2024 · 3 comments

Comments

@Adafede
Copy link

Adafede commented Oct 21, 2024

In the frame of my review for openjournals/joss-reviews#7313.

When I landed on https://github.com/JuBiotech/peak-performance/tree/main/docs/source/notebooks, of course there is everything I need to reproduce but having some clearer instinctive way to know where to start might help (like 01_create_x, 02_do_this, 03_final_that ...)

On a more personal note, https://marimo.io/ recently got me much more enthusiastic than jupyter notebooks

@Y0dler
Copy link
Collaborator

Y0dler commented Oct 24, 2024

I understand what you mean. The execution of the pertaining notebooks is arbitrary in the sense that they will all work as is. However, the Processing_test_1_raw_data and Create_validation_plot_from_raw_data are sequential. Originally. I only wanted to add the latter but it didn't quite start from the raw data so I had to add the former, as well.
The Create_results_in_figure_2 notebook is completely independent from the other two.

Would it be alright to create a new page in the documentation to briefly explain the purpose of the notebooks and their relation?

@Y0dler
Copy link
Collaborator

Y0dler commented Oct 24, 2024

I added such a new entry in #35.

@Adafede
Copy link
Author

Adafede commented Oct 24, 2024

👍🏼

@Adafede Adafede closed this as completed Oct 24, 2024
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

2 participants