OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
Make cookbook materials fetchables
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 70
- Forks
- 15
- Ø Merge
- 10 Std. 42 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit openfecli/fetchables.py, um vorhandene Muster für abrufbare Ressourcen zu untersuchen, und sieh dir anschließend die Cookbook-Notebooks sowie die in der Issue genannten duplizierten Eingabedateien an. Koordiniere das OpenFE-Release und die Versionsaktualisierung in ExampleNotebooks, bevor du die Setup-Zeilen der Notebooks änderst. Als erledigt gilt die Aufgabe, wenn die erforderlichen Cookbook-Eingaben über OpenFE heruntergeladen werden und ein einzelnes Notebook ohne Repository-Klon oder Tarball funktioniert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter-notebook
- Bereich
- cli, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100