[PRE REVIEW]: Cylc: a Workflow Engine for Automating Cycling Systems

[whedon]

Submitting author: @hjoliver (Hilary Oliver) Repository: https://github.com/cylc/cylc Version: cylc-7.6.1 Editor: @arfon Reviewers: @sarats, @Chilipp

Author instructions

Thanks for submitting your paper to JOSS @hjoliver. The JOSS editor (shown at the top of this issue) will work with you on this issue to find a reviewer for your submission before creating the main review issue.

@hjoliver if you have any suggestions for potential reviewers then please mention them here in this thread. In addition, this list of people have already agreed to review for JOSS and may be suitable for this submission.

Editor instructions

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

@whedon commands

[whedon]

Hello human, I'm @whedon. I'm here to help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@whedon commands

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

PDF failed to compile for issue #716 with the following error:

% Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed

0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 100 11 0 11 0 0 72 0 --:--:-- --:--:-- --:--:-- 72 Could not find bibliography file: paper.bib Error running filter pandoc-citeproc: Filter returned error status 1 Looks like we failed to compile the PDF

[hjoliver]

From the list of potential reviewers @ygrange looks good (scientific workflow management, Python).

[hjoliver]

Otherwise reviewers listing "atmospheric science" or possibly "HPC" could work (these are Cylc's core application areas thus far).

[ygrange]

I'm not too familiar with the background application field (maybe I'm wrong and we could actually apply it to Astronomy; haven't really thought very deeply about it tbh) so I may mostly comment on the more technical details. Wouldn't mind having an in-depth look at it though. I will however be unavailable untill the end of next week.

[arfon]

@hjoliver - could you please fix up your paper so it will compile? You can test fixes by posting @whedon generate pdf here.

[hjoliver]

@arfon - the error says "could not find paper.bib", but that file is in the same location as paper.md in the repostory (which is "doc/joss-paper"). The pandoc command given in whedon docs works when I run it manually in that directory. The instruction for authors does not say a specific location is required, or have I missed something?

[hjoliver]

@ygrange - Cylc comes out of atmospheric science where (particularly for operational weather prediction) we have very complex workflows, so the examples in the documentation may give the impression that it is specialized to that area - however it is in fact a generic tool and it could be used anywhere (including Astronomy).

[arfon]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

--> Check article proof :page_facing_up: <--

[ygrange]

So in principle I'd happily do it but I will be looking at it from the direction of a different field (so I will judge the documentation on how clear it is for me as an outsider for example). I leave it to you to judge if that's an angle you want to have covered (not sure of joss allows multiple reviewers to cover different angles).

Going offline for a week now and I'll see what's expected from me next week :)

[hjoliver]

Thanks @ygrange. Regarding documentation, I don't think you'll find it too weather-specialized, except perhaps for the introductory section of the User Guide which dates back to the inception of the project. I'm not sure if this is good news or bad for reviewers, but Cylc is a reasonably large, mature application, so the User Guide is quite big. I suggest you run through one of the presentations here https://cylc.github.io/cylc/documentation.html first as a quick overview.

[arfon]

From the list of potential reviewers @ygrange looks good (scientific workflow management, Python).

@hjoliver - I'd like to get an extra reviewer for this submission. Could you take a look at this list and suggest some others? https://bit.ly/joss-reviewers

Also, if you know the GitHub handles of any other potential good reviewers feel free to mention them here.

[hjoliver]

@arfon - from the list I could suggest @sarats and @Chilipp, who seem to be involved in Earth System Modeling, one of Cylc's primary use cases currently.

If they don't work out I can try to find others, but unfortunately most of my immediate contacts in the subject area are already Cylc users or developers (which is presumably not OK?)

[Chilipp]

@arfon and @hjoliver - Looks interesting, I would be willing to review it

[sarats]

@arfon and @hjoliver I'm happy to review this.

[arfon]

@whedon assign @arfon as editor

[whedon]

OK, the editor is @arfon

[arfon]

@whedon add @sarats as reviewer

[whedon]

OK, @sarats is now a reviewer

[arfon]

@whedon add @Chilipp as reviewer

[whedon]

OK, @Chilipp is now a reviewer

[arfon]

@whedon start review magic-word=bananas

[whedon]

OK, I've started the review over in https://github.com/openjournals/joss-reviews/issues/737. Feel free to close this issue now!

[arfon]

@sarats, @Chilipp - many thanks for agreeing to help out! Please head over to #737 to carry out the review.

[hjoliver]

@sarats, @Chilipp - many thanks from me too.