OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks

Merge cinnabar-absolute and cinnabar RBFE plotting docs

オープン
#313 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Jupyter Notebook
スター
70
フォーク
15
平均マージ
10時間 42分
マージ済み PR(30日)
2

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

cinnabar_absolute.ipynb と plotting_rbfes_with_cinnabar/PlottingFreeEnergiesUsingCinnabar.ipynb を比較し、まず両方の notebook のフローと、openfe CLI の出力をどのように利用しているかを読み取ります。それらを、RBFE と ABFE のセクションを分けた、Cinnabar 用の汎用的なプロット notebook に統合します。その後、両方の結果タイプがカバーされていること、および notebook が openfe のドキュメントに適していることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
jupyter-notebook
領域
cli, documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
68/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。