OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks

Make cookbook materials fetchables

Aperta
#87 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Descrizione

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:

  1. Create the fetchables in the OpenFE CLI. See fetchables.py for examples
  2. Cut a release of OpenFE, update ExampleNotebooks to use that OpenFE version.
  3. Update the cookbook notebooks here to download the required files.

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.

Direzione di ricerca

Inizia da openfecli/fetchables.py per esaminare i pattern esistenti per le risorse recuperabili, poi ispeziona i notebook del cookbook e i file di input duplicati menzionati nella issue. Coordina la release di OpenFE e l’aggiornamento della versione in ExampleNotebooks prima di modificare le righe di configurazione dei notebook. Il lavoro è completato quando gli input necessari del cookbook vengono scaricati tramite OpenFE e un singolo notebook funziona senza un clone del repository né un tarball.

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

Valutazione

Stack tecnologico
jupyter-notebook
Ambito
cli, documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.