User guide or manuals

Hi @nancyyu,

In reality, the PyMedPhys team is in dire need for someone to dive in who has a passion for helping others use PyMedPhys and build out the documentation. See the following talk on YouTube for what the vision for the PyMedPhys documentation is:

There are a range of functions that are documented, and they can be found within the library section of the docs:

https://docs.pymedphys.com/ref/lib

For example, here is the documentation for gamma:

https://docs.pymedphys.com/ref/lib/gamma.html

However, there is a massive need to flesh these documents out in such a way that new users are given wings instead of weights when trying to use PyMedPhys.

Just recently at the bottom of each documentation page I have added discussion links, for example https://docs.pymedphys.com/ref/lib/gamma.html#comments looks like the following:

The idea being, by augmenting the docs with this forum there might be a way to begin building a community who can help each other out, and ultimately, someone might be in a position to begin fleshing out a few documents here and there as they begin using the tools.

As you can imagine, given this is mostly a volunteer gig, most of my time tends to go into getting dirty in the nitty gritty of getting things to work, like what was described over at “How to upgrade Pymedphys - #11 by SimonBiggs”.

At the end of the day, for new users though, a software library is only as good as its documentation. And to that end, at the end of the day, the PyMedPhys community needs to grow, and I am hoping that someone with a passion for community communication and open source software is able to jump in and take that whole part of the project by the horns, find a group of people to help them, and make it so that Medical Physicists and new TEAP registrars can truly be equipped to use Python to do amazing things. :slight_smile: