OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
Make cookbook materials fetchables
まだ誰も着手していません。
- 主要言語
- Jupyter Notebook
- スター
- 70
- フォーク
- 15
- 平均マージ
- 10時間 42分
- マージ済み PR(30日)
- 2
説明
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:
- Create the fetchables in the OpenFE CLI. See fetchables.py for examples
- Cut a release of OpenFE, update ExampleNotebooks to use that OpenFE version.
- Update the cookbook notebooks here to download the required files.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
既存のfetch可能なパターンを確認するためにopenfecli/fetchables.pyから始め、次にcookbookのノートブックとissueで言及されている重複した入力ファイルを調べます。ノートブックのセットアップ行を変更する前に、ExampleNotebooksでのOpenFEのリリースとバージョン更新を調整します。必要なcookbookの入力がOpenFEを通じてダウンロードされ、単一のノートブックがリポジトリのcloneやtarballなしで動作すれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- jupyter-notebook
- 領域
- cli, documentation
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100