Improve documentation

[bastula]

Documentation with more examples would be great.

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

[alexandrecharvier95]

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]

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

[peterfortuin]

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

[bastula]

@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:

dicompyler-core/tests/test_dvh.py

Line 38 in 6418083

def test_raw_data_dvh(self):

dicompyler-core/tests/test_dvh.py

Line 48 in 6418083

def test_raw_data_dvh_max_bins(self):

[bastula]

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