-
-
Notifications
You must be signed in to change notification settings - Fork 36
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
[REVIEW]: hillmaker: A Python package for occupancy analysis in discrete entity flow systems #6154
Comments
Hello humans, 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:
For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:
|
|
Wordcount for |
|
👋🏼 @misken @, @rerickson-usgs, @HLasse this is the review thread for the paper. All of our communications will happen here from now on. As a reviewer, the first step is to create a checklist for your review by entering
as the top of a new comment in this thread. These checklists contain the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. The first comment in this thread also contains links to the JOSS reviewer guidelines. The JOSS review is different from most other journals. Our goal is to work with the authors to help them meet our criteria instead of merely passing judgment on the submission. As such, the reviewers are encouraged to submit issues and pull requests on the software repository. When doing so, please mention We aim for reviews to be completed within 6 weeks at the latest, but of course I understand that you might be away/not available during the holiday period at the end of the year. Please let me know if any of you require significantly more time. We can also use Please feel free to ping me (@mstimberg) if you have any questions/concerns. |
Review checklist for @rerickson-usgsConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @HLasseConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
My checklist is complete. The package works well and has very thorough documentation. Tests pass, and all the tutorials work as expected. The software seems to have been in use (in different forms) for a long time and sees use in multiple projects. I've added a few minor PRs and issues for the authors to consider, but nothing major that should hold back the publication. I recommend the paper for publication. |
Thank you, @HLasse. I much appreciate the PRs and Issues you raised and will get them incorporated. I responded to them individually just now. |
Thank you for inviting me to review this. I should have read the invite better before accepting. That being said, this package seems well done and I recommend accepting. As a feature request, I would to include the equation within the package and not just the supporting paper. I liked the documentation (like this file). An algorithm flow chart might also help. I was not able to install the package, but the problem is my work computer has an SSL intercept and conda is not working for me at the moment. |
👋 @rerickson-usgs Many thanks for your review – if you were mismatched for this review, this would also be my fault as an editor. I have to admit, I wasn't aware of the different uses of the term "occupancy modelling"… Do you feel that you are confident to recommend the paper for acceptance nevertheless? If not, I will find another reviewer that is familiar with the domain.
I am afraid that installing and running the package is a necessary condition for a review. If you don't think you'll be able to do so on your work machine, then this would be another reason for me to find another reviewer. In case it helps: if you can get your IT department to provide you with the certificates it uses, there are (non-trivial…) ways to make conda use them (https://docs.conda.io/projects/conda/en/latest/user-guide/configuration/non-standard-certs.html). An easier solution is to disable SSL verification (https://docs.conda.io/projects/conda/en/latest/user-guide/configuration/disable-ssl-verification.html) but of course this comes with a security risk. Regardless of your answer to these questions, thanks again for volunteering to review and the time you spent on this 🙏! |
@mstimberg I am trying again on cloud based Jupyter Lab and it's working. It have worked before on my laptop, but just takes a looooong time. Perhaps a warning about slow install times might be helpful. |
@mstimberg I was able to complete my review. To put all of my feedback on one comments:
|
Thanks for your review @rerickson-usgs. Glad you were able to install and run. hillmaker doesn't rely on conda, you can do a pip install and it only has a few dependencies. I've never had the install itself be slow, hmm, but I'll look into that. Yes, I can certainly add more technical detail in terms of the algorithm to the docs. It's nothing terribly complex. We are in the process of writing a new hillmaker paper for Health Care Management Science and will be writing up all the technical details as part of that. I can adapt some of that for the docs. I will modify the CONTRIBUTING file and my PyCharm settings to make sure my linter use is consistent and documented. It's funny about the "occupancy modeling" confusion. When I do lit review related to occupancy modeling, I often get results related to the type of ecological occupancy modeling that you do. In addition, I've actually gotten involved in some ecology research with a stream ecologist colleague at Oakland University doing processing of massive amounts of temperature sensor data from loggers in streams. :) |
@rerickson-usgs I added some additional algorithmic details to the doc page on how occupancy is computed. Realized that there was a markdown table that wasn't being rendered to the html docs and fixed that - it illustrates the simple occupancy example on that page. I also added a link to the datetime.py file that does the heavy lifting on the occupancy computations - it's extremely thoroughly commented. Hopefully this will improve things until we get our next paper written and can use that a additional info on how hillmaker works. |
Thanks for the updates @misken. Do these additions address your suggestions/concerns, @rerickson-usgs. In other words, would you recommend the paper/software for acceptance as it is? Thanks 🙏 ! |
@misken I made some minor changes in a PR (misken/hillmaker#79) – please merge if you are fine with all changes. |
Thanks, @mstimberg. Reviewed and merged. Let me know if anything else needed. |
@editorialbot generate pdf |
Everything is looking good from my side. For the final steps, I'll now hand things over to the track editor 🤝 |
@editorialbot recommend-accept |
|
|
👋 @openjournals/sbcs-eics, this paper is ready to be accepted and published. Check final proof 👉📄 Download article If the paper PDF and the deposit XML files look good in openjournals/joss-papers#4957, then you can now move forward with accepting the submission by compiling again with the command |
@mstimberg is there something else I need to do here or is this on your end now? |
@misken There is nothing to do from your side now. Please be patient and wait for the track editor to do the final checks and trigger the actual publication. I can ping them if they don't react within a few days, but given that I recommended the acceptance only two working days ago, I wouldn't do this just yet. |
Thanks @mstimberg, just wanted to make sure I wasn't missing some GitHub thing on my side that needed doing. No need to ping anyone, this isn't urgent. |
@editorialbot recommend-accept |
|
|
👋 @openjournals/sbcs-eics, this paper is ready to be accepted and published. Check final proof 👉📄 Download article If the paper PDF and the deposit XML files look good in openjournals/joss-papers#4965, then you can now move forward with accepting the submission by compiling again with the command |
@editorialbot accept |
|
Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository. If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file. You can copy the contents for your CITATION.cff file here: CITATION.cff
If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation. |
🐘🐘🐘 👉 Toot for this paper 👈 🐘🐘🐘 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? Notify your editorial technical team... |
Huge thanks to the editor @mstimberg and the reviewers @rerickson-usgs, @HLasse! ✨ JOSS appreciates your work and effort. ✨ Also, big congratulations to the authors! 🥳 🍾 |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: We need your help! The Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:
|
Thank you @editorialbot. I have made a donation and signed up to be a reviewer. |
You are welcome |
Submitting author: @misken (Mark Isken)
Repository: https://github.com/misken/hillmaker
Branch with paper.md (empty if default branch):
Version: v0.8.1
Editor: @mstimberg
Reviewers: @rerickson-usgs, @HLasse
Archive: 10.5281/zenodo.10530420
Status
Status badge code:
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) by leaving comments 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
@rerickson-usgs & @HLasse, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:
The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @mstimberg know.
✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨
Checklists
📝 Checklist for @rerickson-usgs
📝 Checklist for @HLasse
The text was updated successfully, but these errors were encountered: