SWIFTSIM / emulator

The SWIFT simulation cosmological emulator (swift-emulator)
GNU Lesser General Public License v3.0
5 stars 2 forks source link

[JOSS review] Comments on paper #39

Closed kstoreyf closed 2 years ago

kstoreyf commented 2 years ago

Part of JOSS review.

The paper contains all of the required information, and is clear and well-written. The authors make a strong case for the utility of this emulation framework, situated between low-level packages and specific applications - indeed, I couldn't find another framework quite like it!

I have a few comments / minor fixes:

  1. For the emulation formula, it would be good to also define the dependent variable y. This is done on the Getting Started page - in fact, it might be nice to have consistent notation between the formula here and the one in the paper (one way or the other).
  2. I don't really understand what the line "This distinction between the values obtained from the simulation and the parameters of the simulation model is absent when setting up a typical emulator” (lines 51-52) is trying to say. Could you elaborate, or use more precise language?
  3. Lines 28-29: Put each citation directly after the simulation project it is for.
  4. Small typos:
    • Line 23: state of the of the art -> state-of-the-art
    • Line 62: Many packages cexist -> exist
    • Line 85: ranging accros -> across
  5. I am wondering about consistency in the name of the emulator. In the paper it is titled swift-emulator, the repo is emulator, the pip install is swiftemulator, and the docs call it both SWIFT-Emulator and SWIFT emulator. I understand that some of these are set by external constraints, e.g. pip not allowing hyphens, and it is usually still clear, but it might be good to have a bit more consistency where possible.
Moyoxkit commented 2 years ago

Thanks for the comments! Changes should be merged now with #40