OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
To commit or not commit notebook output...
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 70
- Forks
- 15
- Merge medio
- 10 h 42 min
- PR fusionados (30 d)
- 2
Descripción
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
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza comparando los notebooks utilizados por la documentación en tutorials/rbfe_python_tutorial.html con la lista de notebooks y los pasos de ejecución de .github/workflows/CI.yml de ExampleNotebooks. Revisa cómo gestiona OpenFF la salida incrustada de los notebooks y, después, define y documenta un workflow cuya salida completada sea coherente en el repositorio y en la documentación renderizada.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- github-actions, jupyter-notebook
- Área
- build-system, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100