Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #37

Open
bastula opened this issue Mar 30, 2018 · 5 comments
Open

Improve documentation #37

bastula opened this issue Mar 30, 2018 · 5 comments

Comments

@bastula
Copy link
Member

bastula commented Mar 30, 2018

Documentation with more examples would be great.

Ideally docstrings need to be completed for the dvhcalc module as well.

@alexandrehuat
Copy link

Hi, there's an issue in https://dicompyler-core.readthedocs.io/en/latest/installation.html
It's written pip install dicompylercore instead of dicompyler-core.

@bastula
Copy link
Member Author

bastula commented Feb 13, 2019

Thanks for that catch. I have just fixed it on master in commit f5f9fa7.

@peterfortuin
Copy link

An example how to create a DVH object from a dose en volume arrays would be nice. I have trouble with it.

@bastula
Copy link
Member Author

bastula commented Oct 7, 2019

@peterfortuin You're correct, there is no explicit documentation in the published docs or in the Jupyter notebook to show how to do that. However, you can follow the test suite and the following functions test_raw_data_dvh and test_raw_data_dvh_max_bins show how to accomplish this:

def test_raw_data_dvh(self):

def test_raw_data_dvh_max_bins(self):

@bastula
Copy link
Member Author

bastula commented Dec 9, 2020

Improve docstrings (including function parameters and return values for) the dvhcalc module per: https://groups.google.com/g/dicompyler/c/Peil-ziqX_c/m/N76sg5kXAgAJ

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants