jonescompneurolab / hnn-core

Simulation and optimization of neural circuits for MEG/EEG source estimates
https://jonescompneurolab.github.io/hnn-core/
BSD 3-Clause "New" or "Revised" License
54 stars 52 forks source link

[JOSS Review] HNN-core: A Python software for cellular and circuit-level interpretation of human MEG/EEG #675

Closed isdanni closed 1 year ago

isdanni commented 1 year ago

Thanks for submitting to JOSS! Please see the following comments for the paper review.

Linking https://github.com/openjournals/joss-reviews/issues/5848 to track review progress.

Summary

N/A

A statement of need

Does the paper have a section titled 'Statement of need' that clearly states what problems the software is designed to solve, who the target audience is, and its relation to other work?

The title of one of the sections needs to be changed to satisfy the publication requirement. I suggest moving part of the content from the "summary" and "HNN-core facilitates reproducibility and computationally expensive workflows" to the "statement of need". In the new summary section, only the high-level functionality and purpose of the software should remain. The "comparison to HNN" part can be trimmed down.

State of the field

N/A

Quality of writing

ntolley commented 1 year ago

Thank you for your comments! I will address the suggestions below

The title of one of the sections needs to be changed to satisfy the publication requirement. I suggest moving part of the content from the "summary" and "HNN-core facilitates reproducibility and computationally expensive workflows" to the "statement of need". In the new summary section, only the high-level functionality and purpose of the software should remain. The "comparison to HNN" part can be trimmed down.

Great suggestions, I’ve done my best to incorporate a statement of need section that fits this description (latest changes have been pushed to the joss_paper branch). Please let us know if this is closer to what you had in mind.

what is the x axis for the top two figures? time. ms?

The 3 panels represent outputs from the same simulation, and therefore share the same x axis representing time in the simulation. If you think this is unclear one option is to update the legend to clarify this.

what is the purpose of image , is it to measure the scale of AMPA/NMDA/...?

This is meant to represent a train of “spikes” arriving from a presynaptic cell. The connections from this cell target the “proximal” portions of the neuron, hence the name “proximal drive”. We have omitted a detailed description of the network in favor of citing the original paper which this figure is derived from.

If you think this should be clarified, one option is updating the legend, or alternatively a small label reading “spike train” could be added to the figure.

Is the second signal named "and alpha" or "alpha"?

This is a punctuation typo actually and we need to omit the comma before “and alpha” since there are only two list items at this level (evoked responses and rhythms, the latter of which is broken into three components)

...The primary electrical currents that create MEG/EEG sensor signals are known to oriented along the long and ...", "to be oriented"?

Good catch! Fixed

There are also a few compound adjectives that need a hyphen. For example, "layer-specific", "Simulation-Based", "long-term", and "GUI-exposed".

Fixed

isdanni commented 1 year ago

Thanks for your detailed comments! I don't have any follow-up questions. For the figure, adding a small label should work. Closing the paper review issue for now.