-
-
Notifications
You must be signed in to change notification settings - Fork 38
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]: Linopy: Linear optimization with n-dimensional labeled variables #4823
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 |
|
Review checklist for @g4brielvsConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Review checklist for @torressaConflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
|
Hi, @FabianHofmann. Sorry for the delay, I want to get the ball rolling on this one so this is my first pass on the review. I will come back with more once I find more time. Really enjoyed looking through this, nicely written code and easy to follow. I have mostly minor comments/things I'd like to see. Feel free to provide arguments why my comments are not needed/appropriate. Benchmarks
General code
General
File Types
Paper edits
|
Hey @toressa, first of all thank you for your detailed review! These are all very helpful comments and I could finally find some time to address them. Since version 0.0.11 actually a lot has happened. A lot has to do with stabilizing the API and the data handling. BenchmarksThe benchmark was extended. It now includes the following models:
which can chosen by the user. The figure in the paper shows the benchmark of the knapsack problem. It compares the following apis:
However, ortools does not yet support gurobi v10, therefore it did not make it into the final figure. The knapsack model and the original problem lead to very similar overheads. So I hope it is okay to not extend the set of benchmark models further. As far I see it, the solution retrieval is included by the all AML's. General codeI added a To answer your question about the preferred tool, from the computational point of view, it does not make a difference which data handling tool (numpy, pandas, xarray) is used, as they all rely on numpy arrays in the background. However, I pointed out in the doc that xarray is the most convenient and safe tool to create variables. GeneralI added a As for the PWL and QC, we discussed a rough but promising structure how to represent them. But for the proper implementation, I will need to have some spare time, or have a motivated and competent student to work on it. So I hope it is fine to not make a requirement for the JOSS contribution. Good point about the more complex example cases. There were already some users asking for it. I created an issue that I will work on in the next weeks. File TypesNetCDF is a data format that is used in many scientific fields. It is a very convenient format to store multidimensional data. It is also the default format for xarray, is extremely fast, and can be used to store large amounts of data. In OR, NetCDF is not used to my knowledge. Its use case here is not transferring a linopy model to other APIs but rather store a linopy model to fast disk. It is also used when solving a linopy model on a remote server. The export in MPS file format is now also supported by linopy. And tested across all solvers PyPSA/linopy#97 The executable files were corrected. CitationI added a citation for PuLP About the naming. Fair point. However I wanted to build the bridge between the data science and the OR community. So, unless I have a brainwave, I would stick to that name. I hope that tackles all the point so far! Thanks again and looking forward to hear from you! Also pinging @g4brielvs whether there are remaining things on the list that I should cover for the package :) |
@Fei-Tao a short question: is it possible to update the version of the package addressed in the paper? |
@FabianHofmann Apologies for my delayed response! I'll add my comments before the end of the week. |
@FabianHofmann Yes. that is possible. @g4brielvs Thanks for your response. Please feel free to let me know if you have any questions about reviewing this submission. |
Great, thank you @g4brielvs and @Fei-Tao |
@g4brielvs just pinging you (perhaps this week suits better) |
Hello @g4brielvs, here are the things you can ask me to do:
|
@FabianHofmann Apologies for the delay. Thank you for submitting this package and after @torressa's comments were addressed, all looks great to me. |
thank you very much @g4brielvs! Gently pinging @torressa, could you have a look at the addressed review comments above? |
@editorialbot generate pdf |
@torressa gently pinging you again. Do you have any remaining comments? |
Thanks for all the work! I think I am happy now with the code. When I ran these on my machine the plots looked slightly different that's why I am asking. Citations: @misc{gurobi,
author = {{Gurobi Optimization, LLC}},
title = {{Gurobi Optimizer Reference Manual}},
year = 2023,
url = "https://www.gurobi.com"
} I didn't really find citation details for the other solvers. |
@torressa thanks for reviewing again. I've created a README for the benchmark which gives all necessary information how to reproduce the plots. Software and hardware specifications are now given here, these are also referenced in the paper. Let me know if there is further things to do :) |
Perfect thanks! |
@editorialbot recommend-accept |
|
|
Hi @openjournals/dsais-eics , the submission looks good to me now. Could you take it from here? |
@Fei-Tao so far nothing happened. Do you know the reason why? |
@FabianHofmann the editor-in-chief is probably busy. Please wait with patience. Hi @openjournals/dsais-eics, could you please take a look at this submission at your convenience? Thanks for your time. |
@Fei-Tao thanks for the reply and sorry if I bother you again. I actually think the |
@FabianHofmann I will try to run the recommend-accept again. |
@editorialbot recommend-accept |
|
👋 @openjournals/dsais-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#4162, then you can now move forward with accepting the submission by compiling again with the command |
Hi @openjournals/dsais-eics, the submission looks good to me now. Could you take it from here? Thanks. |
|
@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. |
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦 |
🐘🐘🐘 👉 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... |
@torressa, @g4brielvs – many thanks for your reviews here and to @Fei-Tao for editing this submission! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you ✨ @FabianHofmann – your paper is now accepted and published in JOSS ⚡🚀💥 |
🎉🎉🎉 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:
|
@arfon great! Thank you a lot! And special thanks to @Fei-Tao for the organization, and @g4brielvs & @torressa for the reviews!! 🎉 |
Submitting author: @FabianHofmann (Fabian Hofmann)
Repository: https://github.com/PyPSA/linopy
Branch with paper.md (empty if default branch): joss
Version: v0.0.11
Editor: @Fei-Tao
Reviewers: @torressa, @g4brielvs
Archive: 10.5281/zenodo.7751989
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
@torressa & @g4brielvs, 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 @Fei-Tao 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 @g4brielvs
📝 Checklist for @torressa
The text was updated successfully, but these errors were encountered: