[PRE REVIEW]: Ecos: An accessible and intuitive co-simulation framework

[editorialbot]

Submitting author: @markaren (Lars Ivar Hatledal)
Repository: https://github.com/Ecos-platform/ecos
Branch with paper.md (empty if default branch): joss
Version: 0.5.5
Editor: @espottesmith
Reviewers: @ElektrikAkar, @elac-safran
Managing EiC: Chris Vernon

Status

Status badge code:

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

Author instructions

Thanks for submitting your paper to JOSS @markaren. Currently, there isn't a JOSS editor assigned to your paper.

@markaren if you have any suggestions for potential reviewers then please mention them here in this thread (without tagging them with an @). You can search the list of people that have already agreed to review and may be suitable for this submission.

Editor instructions

The JOSS submission bot @editorialbot is here to help you find and assign reviewers and start the main review. To find out what @editorialbot can do for you type:

@editorialbot commands

[editorialbot]

Hello human, 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:

@editorialbot commands

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

@editorialbot generate pdf

[editorialbot]

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

✅ OK DOIs

- None

🟡 SKIP DOIs

- No DOI given, and none found for title: The functional mockup interface for tool independe...
- No DOI given, and none found for title: FMPy - A Python library to simulate Functional Moc...
- No DOI given, and none found for title: Modelica-association-project “system structure and...
- No DOI given, and none found for title: OMSimulator-Integrated FMI and TLM-based Co-simula...
- No DOI given, and none found for title: Open simulation platform–An open-source project fo...

❌ MISSING DOIs

- 10.3384/ecp12076173 may be a valid DOI for title: Functional mockup interface 2.0: The standard for ...
- 10.3384/ecp2118117 may be a valid DOI for title: The functional mock-up interface 3.0-new features ...
- 10.1016/j.simpat.2020.102243 may be a valid DOI for title: Vico: An entity-component-system based co-simulati...

❌ INVALID DOIs

- None

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.98  T=0.18 s (1621.8 files/s, 352121.3 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
C/C++ Header                   176           5774           4850          28490
C++                             56           4030            708          14974
XSD                              6            124             33           1660
Python                          17            290              0            755
XML                             11             45              0            522
CMake                           12            121             19            425
Markdown                         3             83              0            223
YAML                             4             19              4            175
Text                             5             43              0            135
TeX                              1              7              0             59
reStructuredText                 1              5              0             22
Dockerfile                       1              4              0             17
-------------------------------------------------------------------------------
SUM:                           293          10545           5614          47457
-------------------------------------------------------------------------------

Commit count by author:

   429	Lars Ivar Hatledal

[editorialbot]

Paper file info:

📄 Wordcount for paper.md is 430

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: MIT License (Valid open source OSI approved license)

[editorialbot]

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

[editorialbot]

Five most similar historical JOSS papers:

CoSApp: a Python library to create, simulate and design complex systems.
Submitting author: @elac-safran
Handling editor: @HaoZeke (Active)
Reviewers: @jbussemaker, @chenxinye
Similarity score: 0.7119

neworder: a dynamic microsimulation framework for Python
Submitting author: @virgesmith
Handling editor: @danielskatz (Active)
Reviewers: @platipodium, @tresoldi
Similarity score: 0.7118

ezc3d: An easy C3D file I/O cross-platform solution for C++, Python and MATLAB
Submitting author: @pariterre
Handling editor: @Kevin-Mattheus-Moerman (Active)
Reviewers: @melund, @BKillen05, @modenaxe
Similarity score: 0.7114

Calliope: a multi-scale energy systems modelling framework
Submitting author: @sjpfenninger
Handling editor: @jedbrown (Active)
Reviewers: @mdoucet, @gonsie, @ecotillasanchez
Similarity score: 0.7108

Simulation Decomposition in Python
Submitting author: @tupui
Handling editor: @crvernon (Active)
Reviewers: @JoshuaOsborneDATA, @matt-graham
Similarity score: 0.7088

⚠️ Note to editors: If these papers look like they might be a good match, click through to the review issue for that paper and invite one or more of the authors before considering asking the reviewers of these papers to review again for JOSS.

[crvernon]

@editorialbot invite @espottesmith as editor

👋 @espottesmith - would you like to take this one on as editor?

[editorialbot]

Invitation to edit this submission sent!

[espottesmith]

Hey @crvernon. Yep, I can take this one on.

@markaren, it'd be helpful if you provided a list of potential reviewers. You can look at the authors of the suggested papers listed above or use our "search for reviewers" tool.

I took at look at your paper, and while you do seem to meet all of our criteria, the descriptions are rather bare-bones at the moment. In particular, I'd love to see a more detailed comparison between ecos and other similar tools.

[espottesmith]

@editorialbot assign @espottesmith as editor

[editorialbot]

Assigned! @espottesmith is now the editor

[markaren]

Possible reviewers: @elac-safran, @lgiannantoni, @parikshitbajpai, @ElektrikAkar

I took at look at your paper, and while you do seem to meet all of our criteria, the descriptions are rather bare-bones at the moment. In particular, I'd love to see a more detailed comparison between ecos and other similar tools.

I will look into it.

[ElektrikAkar]

Hello, thank you very much for suggesting me as a reviewer. The software looks interesting. I would be happy to review the repository in 3 weeks of timeframe.

[espottesmith]

Thank you @ElektrikAkar!

[espottesmith]

@editorialbot add @ElektrikAkar as reviewer

[editorialbot]

@ElektrikAkar added to the reviewers list!

[elac-safran]

Thank you for suggesting me as a reviewer. I'm in!

[espottesmith]

@editorialbot add @elac-safran as reviewer

[editorialbot]

@elac-safran added to the reviewers list!

[espottesmith]

Alright, with two reviewers having agreed, I'll go ahead and open the review issue.

[espottesmith]

@editorialbot start review

[editorialbot]

OK, I've started the review over in #8182.