To commit or not commit notebook output...
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- github-actions, jupyter-notebook
- Domain
- build-system, documentation
Research direction
Start by comparing the notebooks used by the docs at tutorials/rbfe_python_tutorial.html with the notebook list and execution steps in .github/workflows/CI.yml from ExampleNotebooks. Review how OpenFF handles embedded notebook output, then define and document a workflow whose completed output is consistent in the repository and rendered docs.
Written by the indexing model from the issue text.
Description
I do think that it is best practice to not keep the output BUT we need the output so that our docs render the output:
https://docs.openfree.energy/en/stable/tutorials/rbfe_python_tutorial.html
I think what we should do is maybe have CI do the rendering (it already does the running (at least on these notebooks https://github.com/OpenFreeEnergy/ExampleNotebooks/blob/main/.github/workflows/CI.yml#L68 we will want to make sure those are a 1-1 match of the notebooks we have in our docs))
We could have the result of running the notebooks committed on merge into main? That way it won't clutter up the PR (with each CI run you would need to pull changes) BUT I don't think that would actually help since the output would still be saved...
We could have RTD keep the output which would fix the issue of the docs not having the output BUT that means that if you clone the repo or view the repo with a web browser there still would be no output.
I am not really sure what we should do here, maybe see what OpenFF does? They have the same-ish setup for embedding notebooks in their docs.
This will probably be a bigger issue to work out BUT I think the typo fixes you have here are great 🎉 so could you include the output for now? I will turn this comment into an issue that we can use to discuss what we want to do RE: notebook output being committed.
Originally posted by @mikemhenry in https://github.com/OpenFreeEnergy/ExampleNotebooks/issues/163#issuecomment-2402982475
- Dominant language
- Jupyter Notebook
- Stars
- 70
- Forks
- 15
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 4
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenFreeEnergy/ExampleNotebooks
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Getting AshGC charges cookbookPossibly taken @jthorton claimed this 1 day ago. Open
OpenFreeEnergy/ExampleNotebooks#328 · 1 assignee ·
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
OpenFreeEnergy/ExampleNotebooks#279 · 1 comment ·
All issues in OpenFreeEnergy/ExampleNotebooks
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
block/artifact-swap#176 ·
-
area:lint-tooling bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
InauguralSystems/EigenScript#1340 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
Mend: dependency security vulnerability untriaged
Difficulty 1/5 Under an hour Newbie friendliness 88/100
opensearch-project/OpenSearch-Dashboards#12816 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day