OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
Merge cinnabar-absolute and cinnabar RBFE plotting docs
Nessuno ha ancora preso questa issue.
- Lingua principale
- Jupyter Notebook
- Stelle
- 70
- Fork
- 15
- Merge medio
- 10h 42m
- PR unite (30g)
- 2
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Confronta cinnabar_absolute.ipynb con plotting_rbfes_with_cinnabar/PlottingFreeEnergiesUsingCinnabar.ipynb, iniziando col leggere i flussi di entrambi i notebook e il modo in cui utilizzano gli output della openfe CLI. Uniscili in un notebook generale per il plotting con Cinnabar, con sezioni distinte per RBFE e ABFE, quindi verifica che entrambi i tipi di risultato siano coperti e che il notebook sia adatto alla documentazione di openfe.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- jupyter-notebook
- Ambito
- cli, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 68/100