OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks

Make cookbook materials fetchables

未关闭
#87 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Jupyter Notebook
星标
70
派生
15
平均合并
10 小时 42 分钟
30 天内合并 PR
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:

  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.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

先从 openfecli/fetchables.py 开始,查看现有的可获取资源模式,然后检查 cookbook notebooks 以及 issue 中提到的重复输入文件。在修改 notebook 设置行之前,协调 OpenFE 的发布和 ExampleNotebooks 中的版本更新。所需的 cookbook 输入能够通过 OpenFE 下载,并且单个 notebook 无需克隆仓库或 tarball 即可运行,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
jupyter-notebook
领域
cli, documentation
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。