OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks

Make cookbook materials fetchables

Ouverte
#87 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Jupyter Notebook
Étoiles
70
Forks
15
Merge moyen
10 h 42 min
PR mergées (30 j)
2

Description

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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par openfecli/fetchables.py pour examiner les modèles existants de ressources récupérables, puis inspectez les notebooks du cookbook et les fichiers d’entrée en double mentionnés dans l’issue. Coordonnez la release d’OpenFE et la mise à jour de version dans ExampleNotebooks avant de modifier les lignes de configuration des notebooks. C’est terminé lorsque les entrées nécessaires du cookbook se téléchargent via OpenFE et qu’un seul notebook fonctionne sans clone du dépôt ni tarball.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
jupyter-notebook
Domaine
cli, documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.