[REVIEW]: dfitspy

[whedon]

Submitting author: @astrom-tom (Romain Thomas) Repository: https://github.com/astrom-tom/dfitspy Version: v19.3.3 Editor: @arfon Reviewer: @taldcroft Archive: 10.5281/zenodo.2592698

Status

Status badge code:

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

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@taldcroft, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

1. Make sure you're logged in to your GitHub account
2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @arfon know.

✨ Please try and complete your review in the next two weeks ✨

Review checklist for @taldcroft

Conflict of interest

• [x] As the reviewer I confirm that I have read the JOSS conflict of interest policy and that there are no conflicts of interest for me to review this work.

Code of Conduct

• [x] I confirm that I read and will adhere to the JOSS code of conduct.

General checks

• [x] Repository: Is the source code for this software available at the repository url?
• [x] License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
• [x] Version: v19.3.3
• [x] Authorship: Has the submitting author (@astrom-tom) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

• [x] Installation: Does installation proceed as outlined in the documentation?
• [x] Functionality: Have the functional claims of the software been confirmed?
• [x] Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

• [x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• [x] Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
• [x] Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
• [x] Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
• [x] Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?
• [x] Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

• [x] Authors: Does the paper.md file include a list of authors with their affiliations?
• [x] A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
• [x] References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

[whedon]

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @taldcroft it looks like you're currently assigned as the reviewer for this paper :tada:.

:star: Important :star:

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

2. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

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

@whedon commands

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

:point_right: Check article proof :page_facing_up: :point_left:

[arfon]

@taldcroft - please carry out your review in this issue by updating the checklist above and giving feedback in this issue. The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html

Any questions/concerns please let me know.

[arfon]

:wave: @taldcroft - a friendly reminder that you said you thought you'd be able to complete your review by the 12th March :smile:

[taldcroft]

Yup, it's on my calendar!

[taldcroft]

Minor comments on the article proof:

• fits is an acronym and should always be capitalized as FITS.
• usefull => useful.
• used natively inside a another program (extra a)
• strenghth => strength
• Not sure of JOSS standards, but I believe Python should always be capitalized.
• Therefore fits file can => Therefore FITS files can (plural files)
• There is a space in the URL for the www.eso.org/... link. Note also that this link goes to a page that provides man page links for the original dfits and fitsort standalone tools, but both those links are broken. Can you dig up any working links for the dfits and fitsort man pages?

[taldcroft]

@arfon @astrom-tom - Review completed.

I opened a number of issues that I think should be addressed (by fixing or discussion). These issues are the source of unchecked boxes in the review checklist.

• https://github.com/astrom-tom/dfitspy/issues/3
• https://github.com/astrom-tom/dfitspy/issues/4
• https://github.com/astrom-tom/dfitspy/issues/5
• https://github.com/astrom-tom/dfitspy/issues/6
• https://github.com/astrom-tom/dfitspy/issues/7
• https://github.com/astrom-tom/dfitspy/issues/8
• https://github.com/astrom-tom/dfitspy/issues/9
• https://github.com/astrom-tom/dfitspy/issues/10
• https://github.com/astrom-tom/dfitspy/issues/11

Overall I see the utility in this package as a standalone package, separate from astropy or fitsio. (For astropy there is a GPL / BSD license problem anyway). When we've ironed the issues I opened then I'll be happy to recommend inclusion to JOSS. :smile:

[arfon]

👍 thanks @taldcroft. Over to you @astrom-tom

[astrom-tom]

Thanks you very much @taldcroft! I will be working on a revision in the next few days and get back to you with a revised version!

I will close the issue as I fix them. @arfon, Can I submit a new version number after the corrections?

[astrom-tom]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

:point_right: Check article proof :page_facing_up: :point_left:

[astrom-tom]

Dear @arfon ,

What is the process to resubmit the code?

Thanks!

[taldcroft]

@astrom-tom - still 3 open issues that you should address prior to resubmitting. None of them are difficult. :smile:

[arfon]

What is the process to resubmit the code?

Please just let me know here once you've updated your code based on @taldcroft's feedback. There's no need to resubmit - you simply have to update this issue letting us know you've made the changes.

[astrom-tom]

@taldcroft, @arfon The remaining issues have been adressed and the code have been updated and moved to the main pypi repository. The new version is 19.3.3.

[taldcroft]

All good now, I've reviewed and closed the outstanding issues and have now checked off the remaining review boxes.

From my perspective I'm pleased to recommend to @arfon and the editors that dfitspy be accepted to JOSS.

:tada:

[arfon]

@whedon set v19.3.3 as version

[whedon]

OK. v19.3.3 is the version.

[arfon]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

:point_right: Check article proof :page_facing_up: :point_left:

[arfon]

Thanks @taldcroft!

@astrom-tom - your paper is currently very short. Do you think it would be possible to add a little more detail for example discussing the need for this software and some examples of usage? https://joss.readthedocs.io/en/latest/submitting.html#what-should-my-paper-contain

[astrom-tom]

Thanks so much @taldcroft & @arfon !

@arfon I will try to add some more in the paper today and I will let you know when I think it is ready. Also, is it ok to put dfitspy to ASCL when the final paper is made?

[astrom-tom]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

:point_right: Check article proof :page_facing_up: :point_left:

[astrom-tom]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

:point_right: Check article proof :page_facing_up: :point_left:

[astrom-tom]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

PDF failed to compile for issue #1249 with the following error:

% Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed

0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 100 15 0 15 0 0 189 0 --:--:-- --:--:-- --:--:-- 189 Error producing PDF. ! LaTeX Error: Lonely \item--perhaps a missing list environment.

See the LaTeX manual or LaTeX Companion for explanation. Type H for immediate help. ...

l.325

Looks like we failed to compile the PDF

[astrom-tom]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

PDF failed to compile for issue #1249 with the following error:

% Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed

0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 100 15 0 15 0 0 153 0 --:--:-- --:--:-- --:--:-- 154 Error producing PDF. ! LaTeX Error: Lonely \item--perhaps a missing list environment.

See the LaTeX manual or LaTeX Companion for explanation. Type H for immediate help. ...

l.325

Looks like we failed to compile the PDF

[astrom-tom]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

:point_right: Check article proof :page_facing_up: :point_left:

[astrom-tom]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

:point_right: Check article proof :page_facing_up: :point_left:

[astrom-tom]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

:point_right: Check article proof :page_facing_up: :point_left:

[astrom-tom]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

:point_right: Check article proof :page_facing_up: :point_left:

[astrom-tom]

@whedon generate pdf