pyOpenSci / software-submission

Submit your package for review by pyOpenSci here! If you have questions please post them here: https://pyopensci.discourse.group/
94 stars 36 forks source link

PyMedPhys #39

Closed SimonBiggs closed 3 years ago

SimonBiggs commented 3 years ago

Submitting Author: Simon Biggs (@SimonBiggs)
Package Name: PyMedPhys One-Line Description of Package: A python library providing tools for Medical Physicists. Repository Link (if existing): https://github.com/pymedphys/pymedphys


Description

Provides a central hub for Medical Physicists to share and review each others code that improves their day-to-day job. It also provides analysis tools that supports Medical Physics research.

Scope

See description above.

Medical Physicists.

Similar tools, pylinac and pydicom. PyMedPhys complements these packages often builds on top of them.

P.S. *Have feedback/comments about our review process? Leave a comment here

lwasser commented 3 years ago

hi there @SimonBiggs ! Welcome to pyopensci! Can you tell us a bit more about this submission? It doesn't look to me like this is a python package on it's own, rather a community / subset of packages similar maybe to astropy? please let me know what you are looking for here. And perhaps you can provide some more information about the peer review part of things as that is what we do here at pyopensci!

SimonBiggs commented 3 years ago

Hi @lwasser,

We're in an interesting scenario where people are using the code within publications:

But we don't actually have a paper out there. I began to attempt to write a JOSS paper (https://joss.theoj.org/) for the gamma implementation, but it appears that one repo can't have multiple papers, it'd be handy to be able to have just a pymedphys.gamma paper, and then have ways where other contributors can spin off papers/get peer review, for sub-modules.

I saw that for a JOSS submission it can be easier if it has gone through the pyOpenSci process first. Might it be possible to attempt to have the above pymedphys.gamma module to go through review here? And then see how easy it would be to submit a JOSS paper just for that subsection of PyMedPhys? This would then pave the way for others within the PyMedPhys community to follow a similar process...

Cheers, Simon

lwasser commented 3 years ago

hi again @SimonBiggs help me understand this a bit better. we currently review python packages which would follow the JOSS model that there is one package within a single repo that is curated, citable etc. It sounds as if this may be a set of submodules which similar to JOSS, we don't have the infrastructure right now to support review for as the citation would be on the repo rather than sub sections of the repo. Some issues would come up because:

Do i understand this correctly? We may have to put this on hold if that is the case for the time being until we figure out a way that this type of review could be implemented in a sustainable way. But please do let me know if i am mis understanding the goal here.

lwasser commented 3 years ago

i will say that we are planning to work with other communities to implement uniform standards and such - pangeo being one of them - so perhaps there is a way we can work together in the future even if we can't perform a review right now.

SimonBiggs commented 3 years ago

Do i understand this correctly? We may have to put this on hold if that is the case for the time being until we figure out a way that this type of review could be implemented in a sustainable way.

Yup, I think you've got it to a tee. I'm all for making sure which ever way it occurs it is sustainable. Happy to just stay on the radar for now until the approach is more supported.

Cheers :slightly_smiling_face:, Simon

lwasser commented 3 years ago

@SimonBiggs of course. i am going to close this issue for the time being but please do keep in touch with us. Cheers! :)

SimonBiggs commented 3 years ago

Awesome :) thanks @lwasser