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

[PRE REVIEW]: PyOrthanc: A Python Interface for Orthanc DICOM Servers #7236

Closed
editorialbot opened this issue Sep 16, 2024 · 49 comments
Closed
Assignees
Labels
Dockerfile pre-review Python TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials waitlisted Submissions in the JOSS backlog due to reduced service mode.

Comments

@editorialbot
Copy link
Collaborator

editorialbot commented Sep 16, 2024

Submitting author: @gacou54 (Gabriel Couture)
Repository: https://github.com/gacou54/pyorthanc
Branch with paper.md (empty if default branch): joss
Version: v1.18.0
Editor: @sappelhoff
Reviewers: @sinhaharsh, @jrkerns, @devnums
Managing EiC: Kevin M. Moerman

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/73f4c5a5e026aa4ef0e7ed9ed471a9a7"><img src="https://joss.theoj.org/papers/73f4c5a5e026aa4ef0e7ed9ed471a9a7/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/73f4c5a5e026aa4ef0e7ed9ed471a9a7/status.svg)](https://joss.theoj.org/papers/73f4c5a5e026aa4ef0e7ed9ed471a9a7)

Author instructions

Thanks for submitting your paper to JOSS @gacou54. Currently, there isn't a JOSS editor assigned to your paper.

@gacou54 if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands
@editorialbot editorialbot added pre-review Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials labels Sep 16, 2024
@editorialbot
Copy link
Collaborator Author

Hello human, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- None

🟡 SKIP DOIs

- No DOI given, and none found for title: Digital Imaging and Communications in Medicine (DI...
- No DOI given, and none found for title: HTTPX: A next-generation HTTP client for Python
- No DOI given, and none found for title: simple-openapi-client: OpenAPI Python client gener...

❌ MISSING DOIs

- 10.1007/s10278-018-0082-y may be a valid DOI for title: The Orthanc Ecosystem for Medical Imaging

❌ INVALID DOIs

- None

@editorialbot
Copy link
Collaborator Author

Software report:

github.com/AlDanial/cloc v 1.90  T=0.25 s (196.4 files/s, 98734.2 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          34           4159          11810           8103
Markdown                         2             73              0            226
YAML                             2              3              0             43
TeX                              1              3              0             31
DOS Batch                        1              8              1             26
reStructuredText                 4             13             40             23
JSON                             2              0              0             19
TOML                             1              3              0             18
make                             1              4              6              9
Dockerfile                       1              5              0              7
-------------------------------------------------------------------------------
SUM:                            49           4271          11857           8505
-------------------------------------------------------------------------------

Commit count by author:

   205	Gabriel Couture
     6	Yannick Lemaréchal
     1	Justin Hamel

@editorialbot
Copy link
Collaborator Author

Paper file info:

📄 Wordcount for paper.md is 718

✅ The paper includes a Statement of need section

@editorialbot
Copy link
Collaborator Author

License info:

✅ License found: MIT License (Valid open source OSI approved license)

@editorialbot
Copy link
Collaborator Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@editorialbot
Copy link
Collaborator Author

Five most similar historical JOSS papers:

CleanX: A Python library for data cleaning of large sets of radiology images
Submitting author: @drcandacemakedamoore
Handling editor: @cMadan (Retired)
Reviewers: @henrykironde, @anki-xyz
Similarity score: 0.7397

MRdataset : A unified and user-friendly interface to medical imaging datasets
Submitting author: @sinhaharsh
Handling editor: @mstimberg (Active)
Reviewers: @htwangtw, @djmannion
Similarity score: 0.7163

giotto-deep: A Python Package for Topological Deep Learning
Submitting author: @matteocao
Handling editor: @osorensen (Active)
Reviewers: @EduPH, @leotrs, @ismailguzel
Similarity score: 0.7136

Pylinac: Image analysis for routine quality assurance in radiotherapy
Submitting author: @jrkerns
Handling editor: @kellyrowland (Active)
Reviewers: @ProfLeao, @SimonBiggs
Similarity score: 0.7117

Pyheartlib: A Python package for processing electrocardiogram signals
Submitting author: @devnums
Handling editor: @britta-wstnr (Active)
Reviewers: @cudmore, @LegrandNico, @Bsingstad
Similarity score: 0.7072

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

@gacou54
Copy link

gacou54 commented Sep 16, 2024

@editorialbot check references

@editorialbot
Copy link
Collaborator Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.1007/s10278-018-0082-y is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Digital Imaging and Communications in Medicine (DI...
- No DOI given, and none found for title: HTTPX: A next-generation HTTP client for Python
- No DOI given, and none found for title: simple-openapi-client: OpenAPI Python client gener...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- None

@Kevin-Mattheus-Moerman Kevin-Mattheus-Moerman added the waitlisted Submissions in the JOSS backlog due to reduced service mode. label Sep 23, 2024
@Kevin-Mattheus-Moerman
Copy link
Member

@gacou54 Dear author, thanks for this submission. I am the AEiC on this track and here to help process the initial steps. For the moment I have waitlisted this submission, since all editors in this domain are currently unfortunately preoccupied with other submissions.

@Kevin-Mattheus-Moerman
Copy link
Member

@srmnitc is this submission something you can help edit? It may not be your core topic, but I was wondering if you could help given your work on research data management and workflows.

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot invite @srmnitc as editor

@editorialbot
Copy link
Collaborator Author

Invitation to edit this submission sent!

@gacou54
Copy link

gacou54 commented Sep 23, 2024

Thanks @Kevin-Mattheus-Moerman , pyorthanc doesn't have much domain logic. It's mainly a wrapper to communicate with Orthanc's REST API (Orthanc is an open-source medical images server) with utility functions. So I think anyone with Python + REST API knowledge could review it.

pyorthanc is already used by many, so (I hope :) ) the library has proven its relevance and deserves publication.

@Kevin-Mattheus-Moerman
Copy link
Member

@gacou54 thanks for your comments. Although I'm convinced this represents a significant piece of work, that is no doubt very useful, I am a little worried if this work is in scope for JOSS, e.g. our guidelines say “Minor utility” packages, including “thin” API clients, and single-function packages are not acceptable. Although this submission seems substantial enough in terms of number of lines of code (so not very thin), can it arguably be defined as a wrapper/single-function utility package?

JOSS publishes "research software", i.e. software that is used for scientific research. A good check for JOSS scope is to image if one would feel the need to cite this work when used in such scientific research. There is typically no need to cite a utility tool but one would cite something that would influence the scientific findings directly. So can you help sketch a scenario where people would use your software in scientific research and where people would feel the need to cite your package because it influences the scientific findings/conclusions? Has this work been used and cited in scientific research papers already?

Any clarification on the above would be very helpful to understand if this represents research software. Thanks.

@gacou54
Copy link

gacou54 commented Sep 25, 2024

I understand the issue you raised. PyOrthanc is used in several research projects and is an important element in medical imaging data management projects.

PyOrthanc is typically used upstream in anonymization and data transfer flows, and downstream for complex data management and queries. On our side, we are working on a medical imaging platform dedicated to AI and other algorithms in research (https://paradim.science/), and we orchestrate the data with PyOrthanc.

One of the reasons why we would like to publish in JOSS is that we often see that PyOrthanc is used at scientific conferences for medical imaging projects and we would like people to cite our work.

We will rely on your judgment on its publication value. While it is true that PyOrthanc is a fancy wrapper with several utility functions, its main purpose and the reason we created this tool is to support medical image research. In our opinion, PyOrthanc is a real asset for many medical imaging data management endeavors.

@Kevin-Mattheus-Moerman
Copy link
Member

@gacou54 thanks for answering my question. I think I am happy to proceed.

@Kevin-Mattheus-Moerman
Copy link
Member

@srmnitc can you please help edit this submission if you feel it fits your background? Thanks!

@Kevin-Mattheus-Moerman
Copy link
Member

@srmnitc and is this one you can help with too? Thanks!

@srmnitc
Copy link
Member

srmnitc commented Sep 30, 2024

@Kevin-Mattheus-Moerman this is unfortunately not in my wheelhouse. Ideally, I would like to pass this one.

@Kevin-Mattheus-Moerman
Copy link
Member

@gacou54 apologies for the delays encountered so far. I am still looking for a handling editor however since all in this domain are busy handling other submission we will need to remain patient a bit longer.

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot invite @diehlpk as editor

@editorialbot
Copy link
Collaborator Author

Invitation to edit this submission sent!

@gacou54
Copy link

gacou54 commented Oct 21, 2024

Hi @Kevin-Mattheus-Moerman, I understand, thanks for the follow-up!

@Kevin-Mattheus-Moerman
Copy link
Member

@editorialbot invite @sappelhoff as editor

@editorialbot
Copy link
Collaborator Author

Invitation to edit this submission sent!

@Kevin-Mattheus-Moerman
Copy link
Member

@sappelhoff I was wondering if you could help edit this submission? (I thought I could invite you, since one of the papers you are handling is about to be wrapped up).

@sappelhoff
Copy link
Member

Hi @Kevin-Mattheus-Moerman, yes I am happy to take this on.

@sappelhoff
Copy link
Member

@editorialbot assign @sappelhoff as editor

@editorialbot
Copy link
Collaborator Author

Assigned! @sappelhoff is now the editor

@sappelhoff
Copy link
Member

@gacou54 do you have suggestions for potential reviewers? Please just have potential conflicts of interest in mind.

If not, I will consult the automatic suggestions from above, or will have a look at the JOSS reviewer database.

@gacou54
Copy link

gacou54 commented Nov 26, 2024

Hi @sappelhoff ,

I don't have anyone in particular in mind. I think anyone who has handled DICOM (medical imaging) files as part of their job might have a good idea of ​​what's going on.

The suggestions here seem good to me :)

@sappelhoff
Copy link
Member

👋 @jrkerns @matteocao @sinhaharsh @drcandacemakedamoore @devnums

would any of you be willing to review this submission for JOSS? We carry out our checklist-driven reviews here in GitHub issues and follow these guidelines: https://joss.readthedocs.io/en/latest/review_criteria.html

@sinhaharsh
Copy link

sinhaharsh commented Nov 26, 2024 via email

@jrkerns
Copy link

jrkerns commented Nov 26, 2024

Having personally used the library I'd be happy to review.

@drcandacemakedamoore
Copy link

Due to previous time commitments I would be unable to review until 2025. I am hoping you get enough reviewers before then.

@sappelhoff
Copy link
Member

@editorialbot add @sinhaharsh as reviewer

@editorialbot
Copy link
Collaborator Author

@sinhaharsh added to the reviewers list!

@sappelhoff
Copy link
Member

@editorialbot add @jrkerns as reviewer

@editorialbot
Copy link
Collaborator Author

@jrkerns added to the reviewers list!

@sappelhoff
Copy link
Member

Thanks @sinhaharsh @jrkerns, and @drcandacemakedamoore for your swift replies!

And thanks @sinhaharsh and @jrkerns for volunteering!

@drcandacemakedamoore -- no worries. I hope we will find a third reviewer in the next week or so, but if not, then we can also proceed with @sinhaharsh and @jrkerns.

@sappelhoff
Copy link
Member

I have reached out to @devnums @matteocao via email to see whether they would be interested to review this submission.

@matteocao
Copy link

matteocao commented Dec 2, 2024 via email

@devnums
Copy link

devnums commented Dec 3, 2024

Hi @sappelhoff I have received your email, I would be happy to review this paper. Thank you for inviting me.

@sappelhoff
Copy link
Member

@editorialbot add @devnums as reviewer

@editorialbot
Copy link
Collaborator Author

@devnums added to the reviewers list!

@sappelhoff
Copy link
Member

Thanks for the reply @devnums!

We have 3 reviewers now. I am going to start the proper review.

@sappelhoff
Copy link
Member

@editorialbot start review

@editorialbot
Copy link
Collaborator Author

OK, I've started the review over in #7562.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dockerfile pre-review Python TeX Track: 2 (BCM) Biomedical Engineering, Biosciences, Chemistry, and Materials waitlisted Submissions in the JOSS backlog due to reduced service mode.
Projects
None yet
Development

No branches or pull requests

10 participants