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

[REVIEW]: opty: Software For Trajectory Optimization and Parameter Estimation Using Direct Collocation #300

Closed
17 tasks done
whedon opened this issue Jun 20, 2017 · 120 comments
Closed
17 tasks done
Assignees
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review

Comments

@whedon
Copy link

whedon commented Jun 20, 2017

Submitting author: @moorepants (Jason K. Moore)
Repository: https://github.com/csu-hmc/opty
Version: v0.2.0
Editor: @Kevin-Mattheus-Moerman
Reviewer: @stavness
Archive: 10.5281/zenodo.1162870

Status

status

Status badge code:

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

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 questions

@cybanical, please carry out your review in this issue by updating the checklist below (please make sure you're logged in to GitHub). The reviewer guidelines are available here: http://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @Kevin-Mattheus-Moerman know.

Conflict of interest

  • As the reviewer I confirm that there are no conflicts of interest for me to review this work (such as being a major contributor to the software).

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Version: Does the release version given match the GitHub release (v0.2.0)?
  • Authorship: Has the submitting author (@moorepants) made major contributions to the software?

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: Have any performance claims of the software been confirmed?

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?
  • 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

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

whedon commented Jun 20, 2017

Hello human, I'm @whedon. I'm here to help you with some common editorial tasks for JOSS. @cybanical it looks like you're currently assigned as the reviewer for this paper 🎉.

⭐ Important ⭐

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

To fix this do the following two things:

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

watching

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

notifications

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

@whedon commands

@Kevin-Mattheus-Moerman
Copy link
Member

@moorepants @tvdbogert this is where the review process happens

@Kevin-Mattheus-Moerman
Copy link
Member

@chrisdembia our formal system currently handles a single reviewer but would you be able to act as a second reviewer on this?

@Kevin-Mattheus-Moerman
Copy link
Member

@chrisdembia has also agreed to review.

@moorepants
Copy link
Member

It is worth nothing that Chris is a co-author of mine (at least in the last few years) and we are good friends. I'm not sure of JOSS rules, but in other journals this would likely be a conflict of interest. FYI.

@Kevin-Mattheus-Moerman
Copy link
Member

@moorepants thank you for pointing this out. I will arrange another reviewer.

@moorepants
Copy link
Member

Just checking in on this. It's been well over a month since I submitted.

@Kevin-Mattheus-Moerman
Copy link
Member

👋 @cybanical how are you getting on? Have you started the review process?

@Kevin-Mattheus-Moerman
Copy link
Member

@demotu @siboles @stavness @melund @jslee02 I am looking for an additional reviewer for this submission. Would you be interested in reviewing this for JOSS? The review guidelines are here.

@stavness
Copy link

stavness commented Jul 17, 2017 via email

@Kevin-Mattheus-Moerman
Copy link
Member

Hey @stavness. Mid-August is fine. By then we'll hopefully have some comments from the first reviewer also. Enjoy your vacation.

@cybanical
Copy link

I've got a design review this week. Then I can take some time to getting the toolchain up and running.

@jslee02
Copy link

jslee02 commented Jul 17, 2017

I'm currently in the middle of moving to a different city so my timeline would be similar to @stavness for settling down at the new place. If it's fine and still needs an additional reviewer, then I'd be happy to participate. Just let me know what you think.

@melund
Copy link

melund commented Jul 17, 2017

Hi @Kevin-Mattheus-Moerman. Sorry for slow reply. I am also on holiday at the moment. I see you got your second reviewer, but I don't mind helping out some other time if it is biomechanics related. Funny, I had just watched Kyles presentation on Scipy when I got this notification. JOSS is a much needed initiative.

@Kevin-Mattheus-Moerman
Copy link
Member

@jslee02 @melund Thanks for getting back to me. It looks like most reviewers have vacation etc. so the mid-august time-line is fine. If this submission is of interest to you, and you have time, I would greatly appreciate if you could also help to review this submission. Our formal system handles 1 "official reviewer". But you can review by leaving comments here (i.e. based on the tick-marks at the top of this issue and http://joss.theoj.org/about#reviewer_guidelines).

@demotu
Copy link

demotu commented Jul 17, 2017 via email

@Kevin-Mattheus-Moerman
Copy link
Member

Excellent. Looking forward to seeing your comments.

@cybanical
Copy link

cybanical commented Jul 31, 2017

@moorepants Is this only working on a 32-bit install? I just did a fresh anaconda py3.6 64bit windows install and got this error:

PackageNotFoundError: Package missing in current win-64 channels:
  - opty

Also, windows anaconda is not aware of ipopt, cyipopt.
But, I realize it looks like i need to install ipopt separately. This requires cygwin or mingw, and a drawn out process.

Perhaps there could be a bit more clarity/handholding on windows based installation?

@moorepants
Copy link
Member

moorepants commented Aug 5, 2017

@cybanical Thanks, but i do not support Windows at the moment. You can manually install ipopt and then cyipopt and it should work but I do not have the resources to get it working on windows (or providing instructions). I suggest using a linux VM or docker image and using the install instructions in the readme.

@cybanical
Copy link

@moorepants In that case it might make sense to explicitly state that windows is not supported, rather than give partial instructions for a windows installation - it'd save some headache.

@Kevin-Mattheus-Moerman
Copy link
Member

@moorepants can you more clearly state if Windows is actively supported?
@cybanical will you still be able to review this submission? If needed I can provide you with a Linux environment for testing this software.

@Kevin-Mattheus-Moerman
Copy link
Member

@stavness @jslee02 @melund @demotu we are getting close to mid-august 😄 I hope those who had a vacation had a good one. If you are still able, would you be willing to help review this submission? Thanks!

@moorepants
Copy link
Member

I'm pretty sure that the software will work fine on Windows but have never tested it myself. The user would need to manually install all of the dependencies as per their Windows specific instructions. IPOPT, NumPy, SciPy, etc are not necessarily trivial to compile on Windows but one likely can find binaries. I'm happy to do bug fixes wrt to Windows but do not plan on developing installation instructions for all of the dependencies in the opty documentation, as this can be found in the respective packages' docs. I'm happy to make this clearer in the README.

@demotu
Copy link

demotu commented Aug 16, 2017 via email

@Kevin-Mattheus-Moerman
Copy link
Member

Thanks @demotu you can leave review comments here. Alternatively you can open issues on the repository for this submission and refer to the issues here.

@stavness
Copy link

stavness commented Aug 21, 2017 via email

@Kevin-Mattheus-Moerman
Copy link
Member

@stavness Great, thanks Ian! Let me know if you have any comments on the other aspects, such as documentation (see tickmarks at the top of this issue).

@demotu
Copy link

demotu commented Aug 21, 2017 via email

@whedon
Copy link
Author

whedon commented Jan 29, 2018

https://github.com/openjournals/joss-papers/blob/joss.00300/joss.00300/10.21105.joss.00300.pdf

@moorepants
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 29, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jan 29, 2018

https://github.com/openjournals/joss-papers/blob/joss.00300/joss.00300/10.21105.joss.00300.pdf

@moorepants
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 29, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jan 29, 2018

https://github.com/openjournals/joss-papers/blob/joss.00300/joss.00300/10.21105.joss.00300.pdf

@moorepants
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 29, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jan 29, 2018

https://github.com/openjournals/joss-papers/blob/joss.00300/joss.00300/10.21105.joss.00300.pdf

@moorepants
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Jan 30, 2018

Attempting PDF compilation. Reticulating splines etc...

@whedon
Copy link
Author

whedon commented Jan 30, 2018

https://github.com/openjournals/joss-papers/blob/joss.00300/joss.00300/10.21105.joss.00300.pdf

@moorepants
Copy link
Member

The table fits now. It isn't perfect but it is too difficult to try to fine tune it via markdown and limited control of the LaTeX source. We can go with this.

@arfon
Copy link
Member

arfon commented Jan 30, 2018

OK thanks @moorepants. @Kevin-Mattheus-Moerman - is this submission good to accept now? The checklist at the top of the review isn't filled but it sounds like we might be done based on other comments in the thread.

@stavness
Copy link

stavness commented Jan 30, 2018 via email

@Kevin-Mattheus-Moerman
Copy link
Member

Kevin-Mattheus-Moerman commented Jan 30, 2018

Awesome! Thanks for the review @stavness 🚀 🎉
@demotu @jslee02 thank you as well for your comments!

@Kevin-Mattheus-Moerman
Copy link
Member

@moorepants can you provide a DOI of the reviewed software (e.g. through Zenodo)? Then @arfon can proceed to formally accept this submission.

@moorepants
Copy link
Member

I will package a new release of the software, push to PyPi, conda, and then Zenodo for archival purposes. Note that the version number will go up.

Do we not need to get @jslee02 @cybanical and @demotu's final approval? I addressed comments from all of them in the new version.

@moorepants
Copy link
Member

I've pushed version 1.0.0 to Zenodo:

DOI: 10.5281/zenodo.1162870

https://zenodo.org/record/1162870

@arfon
Copy link
Member

arfon commented Jan 31, 2018

@whedon set 10.5281/zenodo.1162870 as archive

@whedon
Copy link
Author

whedon commented Jan 31, 2018

OK. 10.5281/zenodo.1162870 is the archive.

@arfon arfon added the accepted label Jan 31, 2018
@arfon
Copy link
Member

arfon commented Jan 31, 2018

@stavness @demotu - many thanks for your reviews here and to @Kevin-Mattheus-Moerman for editing this submission ✨

@moorepants - your paper is now accepted into JOSS and your DOI is https://doi.org/10.21105/joss.00300 ⚡️ 🚀 💥

@arfon arfon closed this as completed Jan 31, 2018
@whedon
Copy link
Author

whedon commented Jan 31, 2018

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippet:

[![DOI](http://joss.theoj.org/papers/10.21105/joss.00300/status.svg)](https://doi.org/10.21105/joss.00300)

This is how it will look in your documentation:

DOI

We need your help!

Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider volunteering to review for us sometime in the future. You can add your name to the reviewer list here: http://joss.theoj.org/reviewer-signup.html

@moorepants
Copy link
Member

Thanks everyone. I appreciate the time and effort spent on reviewing this.

@whedon whedon added published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. labels Mar 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS recommend-accept Papers recommended for acceptance in JOSS. review
Projects
None yet
Development

No branches or pull requests

10 participants