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]: DisjunctiveProgramming.jl: Generalized Disjunctive Programming Models and Algorithms for JuMP #117

Closed
21 of 42 tasks
whedon opened this issue Dec 11, 2022 · 59 comments
Closed
21 of 42 tasks

Comments

@whedon
Copy link
Collaborator

whedon commented Dec 11, 2022

Submitting author: @hdavid16 (Hector Perez)
Repository: https://github.com/hdavid16/DisjunctiveProgramming.jl
Branch with paper.md (empty if default branch):
Version: v0.4.1
Editor:
Reviewers: @sbolusani, @joaquimg, @joaquimg
Archive:

Status

status

Status badge code:

HTML: <a href="https://proceedings.juliacon.org/papers/569beb65dae7d35e1ccf220df54e8a1c"><img src="https://proceedings.juliacon.org/papers/569beb65dae7d35e1ccf220df54e8a1c/status.svg"></a>
Markdown: [![status](https://proceedings.juliacon.org/papers/569beb65dae7d35e1ccf220df54e8a1c/status.svg)](https://proceedings.juliacon.org/papers/569beb65dae7d35e1ccf220df54e8a1c)

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

@sbolusani & @joaquimg, 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.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @matbesancon 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

Review checklist for @sbolusani

Conflict of interest

Code of Conduct

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?
  • Authorship: Has the submitting author (@hdavid16) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • 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

  • 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

Paper format

  • Authors: Does the paper.tex 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)?
  • Page limit: Is the page limit for full papers respected by the submitted document?

Content

  • Context: is the scientific context motivating the work correctly presented?
  • Methodology: is the approach taken in the work justified, presented with enough details and reference to reproduce it?
  • Results: are the results presented and compared to approaches with similar goals?

Review checklist for @joaquimg

Conflict of interest

Code of Conduct

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?
  • Authorship: Has the submitting author (@hdavid16) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • 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

  • 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

Paper format

  • Authors: Does the paper.tex 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)?
  • Page limit: Is the page limit for full papers respected by the submitted document?

Content

  • Context: is the scientific context motivating the work correctly presented?
  • Methodology: is the approach taken in the work justified, presented with enough details and reference to reproduce it?
  • Results: are the results presented and compared to approaches with similar goals?
@whedon
Copy link
Collaborator Author

whedon commented Dec 11, 2022

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @sbolusani, @joaquimg it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

⭐ Important ⭐

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/JuliaCon/proceedings-review) 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/JuliaCon/proceedings-review:

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

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

@whedon generate pdf

@whedon
Copy link
Collaborator Author

whedon commented Dec 11, 2022

Failed to discover a Statement of need section in paper

@whedon
Copy link
Collaborator Author

whedon commented Dec 11, 2022

Wordcount for paper.tex is 3421

@whedon
Copy link
Collaborator Author

whedon commented Dec 11, 2022

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.09 s (406.4 files/s, 220866.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
CSS                              2            653             33          14577
TeX                              8            282            178           2855
Julia                           13            149            115           1009
JavaScript                       4             38             64            450
Markdown                         2             20              0             71
YAML                             4              2              0             71
Ruby                             1              8              4             45
TOML                             2              4              0             19
HTML                             2              0              0              4
-------------------------------------------------------------------------------
SUM:                            38           1156            394          19101
-------------------------------------------------------------------------------


Statistical information for the repository '4bdf66050d86061e21566b57' was
gathered on 2022/12/11.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
hdavid16                         2           609              0          100.00

Below are the number of rows from each author that have survived and are still
intact in the current revision:

Author                     Rows      Stability          Age       % in comments
Hector Perez                609          100.0          0.0               11.17

@whedon
Copy link
Collaborator Author

whedon commented Dec 11, 2022

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

@matbesancon
Copy link
Member

@whedon
Copy link
Collaborator Author

whedon commented Dec 11, 2022

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

OK DOIs

- 10.1287/ijoc.2015.0669 is OK
- 10.1007/978-0-387-74759-0_348 is OK
- 10.1007/978-1-4613-0215-5_8 is OK
- 10.1002/9780470400531.eorms0537 is OK
- 10.1007/11527695_15 is OK
- 10.1137/15m1020575 is OK
- 10.1137/15M1020575 is OK
- 10.3390/pr7110839 is OK
- 10.1023/a:1025154322278 is OK
- 10.1007/s10589-020-00176-0 is OK
- 10.1145/3511528.3511535 is OK

MISSING DOIs

- 10.1007/978-3-642-11503-5_12 may be a valid DOI for title: Automating mathematical program transformations
- 10.1007/s12532-017-0130-5 may be a valid DOI for title: Parallelizing the dual revised simplex method
- 10.1016/s0098-1354(98)00293-2 may be a valid DOI for title: LOGMIP: a disjunctive 0–1 non-linear optimizer for process system models
- 10.1007/s12532-011-0026-8 may be a valid DOI for title: Pyomo: modeling and solving mathematical programs in Python

INVALID DOIs

- https://doi.org/10.1016/j.compchemeng.2014.03.014 is INVALID because of 'https://doi.org/' prefix
- https://doi.org/10.1016/B978-0-323-95879-0.50141-7 is INVALID because of 'https://doi.org/' prefix
- https://doi.org/10.1016/j.compchemeng.2021.107616 is INVALID because of 'https://doi.org/' prefix
- https://doi.org/10.1016/j.compchemeng.2022.107856 is INVALID because of 'https://doi.org/' prefix
- https://doi.org/10.1016/j.cherd.2022.08.027 is INVALID because of 'https://doi.org/' prefix
- https://doi.org/10.1002/aic.14088 is INVALID because of 'https://doi.org/' prefix
- https://doi.org/10.1016/j.compchemeng.2015.02.013 is INVALID because of 'https://doi.org/' prefix
- https://doi.org/10.1016/S0098-1354(00)00581-0 is INVALID because of 'https://doi.org/' prefix
- https://doi.org/10.1016/j.compchemeng.2005.04.004 is INVALID because of 'https://doi.org/' prefix

@matbesancon
Copy link
Member

@hdavid16 can you check the DOIs listed above, that's minor but can be done in parallel

@hdavid16
Copy link

@hdavid16 can you check the DOIs listed above, that's minor but can be done in parallel

DOIs have been updated in the repo now.

@whedon
Copy link
Collaborator Author

whedon commented Dec 25, 2022

👋 @sbolusani, please update us on how your review is going (this is an automated reminder).

@whedon
Copy link
Collaborator Author

whedon commented Dec 25, 2022

👋 @joaquimg, please update us on how your review is going (this is an automated reminder).

@matbesancon
Copy link
Member

ping @sbolusani @joaquimg

@hdavid16
Copy link

@sbolusani @joaquimg, this is a friendly reminder to please review. Thank you.

@joaquimg
Copy link
Collaborator

joaquimg commented Apr 8, 2023

Sorry for the delay, I am working on it.

@hdavid16
Copy link

Hi @sbolusani and @joaquimg, I'm sure you are all super busy. But just want to remind you to review this conference paper. It's been almost a year since the last JuliaCon where this work was presented...

@matbesancon
Copy link
Member

I just reminded the two reviewers

@matbesancon
Copy link
Member

@whedon add @joaquimg as a reviewer

@whedon
Copy link
Collaborator Author

whedon commented Aug 9, 2023

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@whedon commands

@matbesancon
Copy link
Member

@whedon add @joaquimg as reviewer

@whedon
Copy link
Collaborator Author

whedon commented Aug 9, 2023

OK, @joaquimg is now a reviewer

@matbesancon
Copy link
Member

@whedon commands

@whedon
Copy link
Collaborator Author

whedon commented Nov 17, 2023

Here are some things you can ask me to do:

# List all of Whedon's capabilities
@whedon commands

# Assign a GitHub user as the sole reviewer of this submission
@whedon assign @username as reviewer

# Add a GitHub user to the reviewers of this submission
@whedon add @username as reviewer

# Re-invite a reviewer (if they can't update checklists)
@whedon re-invite @username as reviewer

# Remove a GitHub user from the reviewers of this submission
@whedon remove @username as reviewer

# List of editor GitHub usernames
@whedon list editors

# List of reviewers together with programming language preferences and domain expertise
@whedon list reviewers

# Change editorial assignment
@whedon assign @username as editor

# Set the software archive DOI at the top of the issue e.g.
@whedon set 10.0000/zenodo.00000 as archive

# Set the software version at the top of the issue e.g.
@whedon set v1.0.1 as version

# Open the review issue
@whedon start review

EDITORIAL TASKS

# All commands can be run on a non-default branch, to do this pass a custom 
# branch name by following the command with `from branch custom-branch-name`.
# For example:

# Compile the paper
@whedon generate pdf

# Compile the paper from alternative branch
@whedon generate pdf from branch custom-branch-name

# Remind an author or reviewer to return to a review after a
# certain period of time (supported units days and weeks)
@whedon remind @reviewer in 2 weeks

# Ask Whedon to do a dry run of accepting the paper and depositing with Crossref
@whedon recommend-accept

# Ask Whedon to check the references for missing DOIs
@whedon check references

# Ask Whedon to check repository statistics for the submitted software
@whedon check repository

EiC TASKS

# Invite an editor to edit a submission (sending them an email)
@whedon invite @editor as editor

# Reject a paper
@whedon reject

# Withdraw a paper
@whedon withdraw

# Ask Whedon to actually accept the paper and deposit with Crossref
@whedon accept deposit=true

@matbesancon
Copy link
Member

@whedon set 10.5281/zenodo.10144853 as archive

@whedon
Copy link
Collaborator Author

whedon commented Nov 17, 2023

OK. 10.5281/zenodo.10144853 is the archive.

@matbesancon
Copy link
Member

@whedon set v0.4.1 as version

@whedon
Copy link
Collaborator Author

whedon commented Nov 17, 2023

OK. v0.4.1 is the version.

@matbesancon
Copy link
Member

@hdavid16 for stylistic reasons, can we replace the successive equations by an align block? This will look much nicer

@matbesancon
Copy link
Member

same for all optimization problems, prefer a template like:

\begin{align*}
\min_{x}\,\, & f(x) \\
\text{s.t. }\, & g(x) \leq 0 \\
& x_i \in X && \forall i \in .. \\
& x \in \mathcal{X}
\end{align*}

@joaquimg
Copy link
Collaborator

joaquimg commented Dec 6, 2023

I do re-iterate @matbesancon comment.

Other than that, good to go on my side.

Great work and congratulations for the nice package!

@hdavid16
Copy link

@joaquimg and @matbesancon the paper has been updated on master as you requested (replacing all equations/expressions with align* blocks).

@matbesancon
Copy link
Member

@whedon generate pdf

@whedon
Copy link
Collaborator Author

whedon commented Dec 12, 2023

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

@matbesancon
Copy link
Member

@whedon recommend-accept

@whedon
Copy link
Collaborator Author

whedon commented Dec 12, 2023

Attempting dry run of processing paper acceptance...

@whedon
Copy link
Collaborator Author

whedon commented Dec 12, 2023

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

OK DOIs

- 10.1007/978-3-642-11503-5_12 is OK
- 10.1007/s12532-017-0130-5 is OK
- 10.1007/978-3-030-00148-3 is OK
- 10.1016/s0098-1354(98)00293-2 is OK
- 10.1287/ijoc.2015.0669 is OK
- 10.1007/978-0-387-74759-0_348 is OK
- 10.1016/j.compchemeng.2014.03.014 is OK
- 10.1007/978-1-4613-0215-5_8 is OK
- 10.1007/978-3-030-68928-5 is OK
- 10.1007/s12532-011-0026-8 is OK
- 10.1016/B978-0-323-95879-0.50141-7 is OK
- 10.1016/j.compchemeng.2021.107616 is OK
- 10.1016/j.compchemeng.2022.107856 is OK
- 10.1016/j.cherd.2022.08.027 is OK
- 10.1002/9780470400531.eorms0537 is OK
- 10.1007/11527695_15 is OK
- 10.1137/15M1020575 is OK
- 10.1137/15M1020575 is OK
- 10.3390/pr7110839 is OK
- 10.1002/aic.14088 is OK
- 10.1007/978-3-030-00148-3 is OK
- 10.1016/j.compchemeng.2015.02.013 is OK
- 10.1016/S0098-1354(00)00581-0 is OK
- 10.1002/9781118627372 is OK
- 10.1023/a:1025154322278 is OK
- 10.1007/s10589-020-00176-0 is OK
- 10.1145/3511528.3511535 is OK
- 10.1016/j.compchemeng.2005.04.004 is OK
- 10.48550/arXiv.2202.05198 is OK
- 10.48550/arXiv.1510.01791 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Collaborator Author

whedon commented Dec 12, 2023

👋 @JuliaCon/jcon-eics, this paper is ready to be accepted and published.

Check final proof 👉 JuliaCon/proceedings-papers#74

If the paper PDF and Crossref deposit XML look good in JuliaCon/proceedings-papers#74, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

@matbesancon
Copy link
Member

@whedon commands

@whedon
Copy link
Collaborator Author

whedon commented Dec 12, 2023

Here are some things you can ask me to do:

# List all of Whedon's capabilities
@whedon commands

# Assign a GitHub user as the sole reviewer of this submission
@whedon assign @username as reviewer

# Add a GitHub user to the reviewers of this submission
@whedon add @username as reviewer

# Re-invite a reviewer (if they can't update checklists)
@whedon re-invite @username as reviewer

# Remove a GitHub user from the reviewers of this submission
@whedon remove @username as reviewer

# List of editor GitHub usernames
@whedon list editors

# List of reviewers together with programming language preferences and domain expertise
@whedon list reviewers

# Change editorial assignment
@whedon assign @username as editor

# Set the software archive DOI at the top of the issue e.g.
@whedon set 10.0000/zenodo.00000 as archive

# Set the software version at the top of the issue e.g.
@whedon set v1.0.1 as version

# Open the review issue
@whedon start review

EDITORIAL TASKS

# All commands can be run on a non-default branch, to do this pass a custom 
# branch name by following the command with `from branch custom-branch-name`.
# For example:

# Compile the paper
@whedon generate pdf

# Compile the paper from alternative branch
@whedon generate pdf from branch custom-branch-name

# Remind an author or reviewer to return to a review after a
# certain period of time (supported units days and weeks)
@whedon remind @reviewer in 2 weeks

# Ask Whedon to do a dry run of accepting the paper and depositing with Crossref
@whedon recommend-accept

# Ask Whedon to check the references for missing DOIs
@whedon check references

# Ask Whedon to check repository statistics for the submitted software
@whedon check repository

EiC TASKS

# Invite an editor to edit a submission (sending them an email)
@whedon invite @editor as editor

# Reject a paper
@whedon reject

# Withdraw a paper
@whedon withdraw

# Ask Whedon to actually accept the paper and deposit with Crossref
@whedon accept deposit=true

@matbesancon
Copy link
Member

@whedon accept deposit=true

@whedon
Copy link
Collaborator Author

whedon commented Dec 12, 2023

Doing it live! Attempting automated processing of paper acceptance...

@whedon
Copy link
Collaborator Author

whedon commented Dec 12, 2023

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JCON! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.jcon.00117 proceedings-papers#75
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/jcon.00117
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@matbesancon
Copy link
Member

congratulations @hdavid16 !

@whedon
Copy link
Collaborator Author

whedon commented Dec 15, 2023

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

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

Markdown:
[![DOI](https://proceedings.juliacon.org/papers/10.21105/jcon.00117/status.svg)](https://doi.org/10.21105/jcon.00117)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/jcon.00117">
  <img src="https://proceedings.juliacon.org/papers/10.21105/jcon.00117/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://proceedings.juliacon.org/papers/10.21105/jcon.00117/status.svg
   :target: https://doi.org/10.21105/jcon.00117

This is how it will look in your documentation:

DOI

We need your help!

JuliaCon Proceedings 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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants