DCC-Lab / DCC-Lab/PyTissueOptics

Documentation and helper function

Đang mở
#129 2 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation enhancement
Ngôn ngữ chính
Python
Star
49
Fork
9
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

This project is great and I fully grasp its potential. However, the status of the documentation and the multilayer OOP where object inherits from others makes it really hard to use.

For e.g. how can one get the energy or fluence as a numpy array to calculate custom metrics? Say I have a beam and want to know the local fluence at a given depth? It's great to have visualization functions, but it's hardly useful for any quantitative interpretation. I dived a bit in the code, but most of it is non-documented and there is no documentation to explain the overall philosophy of the library.

Thanks and keep up the good work!

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

Hướng nghiên cứu

Issue không nêu tệp hay test nào; hãy bắt đầu bằng cách lần theo các đường dẫn trực quan hóa beam và fluence hiện có cũng như cấu trúc kế thừa. Ghi lại triết lý tổng thể của thư viện và chỉ ra cách lấy energy hoặc fluence dưới dạng các mảng NumPy, bao gồm fluence cục bộ tại độ sâu được chọn; công việc được xem là hoàn tất khi người mới có thể làm theo ví dụ để lấy các số liệu định lượng.

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

Đánh giá

Công nghệ
numpy, python
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/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.