OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
Make cookbook materials fetchables
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
Follow-up on #84: There should be a single source of truth for cookbook input files (SDFs, PDBs, etc.) instead of having a copy in, e.g., the OpenFE test suite, with a duplicate stored here.
We could then make the first line of each notebook be ! openfe fetch cookbook-files — this could be either a fetchable per-notebook or a single fetchable to download all cookbook notebooks.
This would have the advantage that even a download of a single notebook would be self-contained, instead of requiring users to download a tarball/clone of the repo.
Steps to make this happen:
- Create the fetchables in the OpenFE CLI. See fetchables.py for examples
- Cut a release of OpenFE, update ExampleNotebooks to use that OpenFE version.
- Update the cookbook notebooks here to download the required files.
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
Comienza con openfecli/fetchables.py para revisar los patrones existentes de recursos descargables y, después, inspecciona los notebooks del cookbook y los archivos de entrada duplicados mencionados en la issue. Coordina el lanzamiento de OpenFE y la actualización de versión en ExampleNotebooks antes de cambiar las líneas de configuración de los notebooks. Se considera terminado cuando las entradas necesarias del cookbook se descargan mediante OpenFE y un único notebook funciona sin un clon del repositorio ni un tarball.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- jupyter-notebook
- Área
- cli, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100