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

JOSS paper: Quality of writing #7

Closed
7 of 8 tasks
jdmoorman opened this issue Dec 16, 2020 · 2 comments
Closed
7 of 8 tasks

JOSS paper: Quality of writing #7

jdmoorman opened this issue Dec 16, 2020 · 2 comments

Comments

@jdmoorman
Copy link

jdmoorman commented Dec 16, 2020

The JOSS paper is well-written. I have only a few minor comments and suggestions.

  • At the start of the third paragraph of the Summary section remove the comma after the word "While".

  • In the third paragraph of the Summary section,

    ... this library provides an efficient implementation of ...

    should say

    ... this library provides efficient implementations of ...

    since there are three implementations provided by the package.

  • In the third paragraph of the Summary section, remove the term "so-called" from the first sentence. The term "so-called" is usually used to imply that something is inappropriately named. If this was the intended meaning, please elaborate on why SPOD is not viewed as an appropriate name.

  • In the third paragraph of the Summary section, the first sentence can be broken into two shorter sentences to improve readability.

    While, several variants of singular-value decomposition based techniques have been proposed in
    the literature, this library provides an efficient implementation of the so-called spectral proper
    orthogonal decomposition (SPOD) (Lumley, 2007), (Towne et al., 2017). SPOD is also referred
    to as spectral empirical orthogonal function (SEOF) in the weather and climate community
    (Schmidt et al., 2019).

  • In the first paragraph of the Capabilities section, please clarify the origin of each variant of SPOD listed in the first sentence. Are all three variants being attributed to (Schmidt & Towne, 2019) or just the streaming version?

  • In the first paragraph of the Capabilities section, change "large RAM" to "high RAM".

  • In the third paragraph of the Capabilities section, remove the duplicated word "figure" from the first sentence.

  • In the third paragraph of the Capabilities section, the parenthetical abbreviations can be omitted since they are never used, unless some readers will only recognize the abbreviations.

@jdmoorman
Copy link
Author

@mengaldo
Copy link
Collaborator

mengaldo commented Mar 1, 2021

@jdmoorman This should now be fixed. We kept the acronyms as they might be helpful to some readers.

@mengaldo mengaldo closed this as completed Mar 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants