OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
Merge cinnabar-absolute and cinnabar RBFE plotting docs
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
https://github.com/OpenFreeEnergy/ExampleNotebooks/blob/main/cookbook/cinnabar_absolute.ipynb is currently not used in the openfe docs, we should merge it into https://github.com/OpenFreeEnergy/ExampleNotebooks/blob/main/plotting_rbfes_with_cinnabar/PlottingFreeEnergiesUsingCinnabar.ipynb to make a general plotting with cinnabar notebook with sections for RBFE and ABFE result plotting starting from outputs from the openfe CLI.
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
Vergleiche cinnabar_absolute.ipynb mit plotting_rbfes_with_cinnabar/PlottingFreeEnergiesUsingCinnabar.ipynb. Beginne damit, die Abläufe beider Notebooks zu lesen und zu untersuchen, wie sie Ausgaben der openfe CLI verwenden. Führe sie zu einem allgemeinen Cinnabar-Plotting-Notebook mit getrennten RBFE- und ABFE-Abschnitten zusammen. Überprüfe anschließend, dass beide Ergebnistypen abgedeckt sind und das Notebook für die openfe-Dokumentation geeignet ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- jupyter-notebook
- Bereich
- cli, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 68/100