OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks

Make cookbook materials fetchables

Đang mở
#87 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Jupyter Notebook
Star
70
Fork
15
Merge trung bình
10 giờ 42 phút
Pull request đã merge (30 ngày)
2

Mô tả

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.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với openfecli/fetchables.py để xem các mẫu fetchable hiện có, sau đó kiểm tra các notebook cookbook và các tệp đầu vào trùng lặp được đề cập trong issue. Phối hợp release của OpenFE và việc cập nhật phiên bản trong ExampleNotebooks trước khi thay đổi các dòng thiết lập của notebook. Được xem là hoàn tất khi các đầu vào cookbook bắt buộc được tải xuống thông qua OpenFE và một notebook duy nhất hoạt động mà không cần clone repository hoặc tarball.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
jupyter-notebook
Lĩnh vực
cli, documentation
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.