Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

To commit or not commit notebook output...

Aperta
#164 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
github-actions, jupyter-notebook
Ambito
build-system, documentation

Direzione di ricerca

Inizia confrontando i notebook utilizzati dalla documentazione in tutorials/rbfe_python_tutorial.html con l’elenco dei notebook e i passaggi di esecuzione in .github/workflows/CI.yml di ExampleNotebooks. Esamina come OpenFF gestisce l’output incorporato dei notebook, quindi definisci e documenta un workflow il cui output completato sia coerente nel repository e nella documentazione renderizzata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Jupyter Notebook
Stelle
70
Fork
15
Merge medio
10h 42m
PR unite (30g)
2

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenFreeEnergy/ExampleNotebooks

Tutte le issue di OpenFreeEnergy/ExampleNotebooks

Issue simili

Altre issue su Build System

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.