DCC-Lab / DCC-Lab/PyTissueOptics

Documentation and helper function

オープン
#129 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る
documentation enhancement
主要言語
Python
スター
49
フォーク
9
PR マージ指標
30日以内にマージされた PR はありません

説明

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!

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

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

評価

この issue はまだ評価されていません。

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

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