[PRE REVIEW]: MCycle: A Python package for 1D sizing and analysis of thermodynamic power cycles

[whedon]

Submitting author: @momargoh (Momar Hughes) Repository: https://github.com/momargoh/MCycle Version: v0.1.2 Editor: @katyhuff Reviewers: @puncan

Author instructions

Thanks for submitting your paper to JOSS @momargoh. 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.

@momargoh 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]

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

[arfon]

:wave: @momargoh - many thanks for your submission to JOSS. I noticed that your project is licensed using a Creative Commons license which is not recommended for software (by Creative Commons) and not allowable in JOSS.

Would you be able to swap the license for one of the OSI-approved ones?

[momargoh]

Hi Arfon, pleasure to meet you and thanks for taking my paper into consideration!

OK, I completely overlooked that before, no worries, I've updated the licence to Apache License 2.0. I've also updated the package version to v0.1.3 because I need to update the licence on PyPI as well. https://github.com/momargoh/MCycle/commit/27676417c080d4662795d859d85e9391d942dca9

[arfon]

:wave: @katyhuff - would you be willing to edit this submission for JOSS?

[katyhuff]

@arfon Yes.

[katyhuff]

@whedon assign @katyhuff as editor

[whedon]

OK, the editor is @katyhuff

[katyhuff]

@kyleniemeyer @trallard @nnadeau : Would any of you be willing to edit this submission? I think you would be very fitting. The topic is "MCycle: A Python package for 1D sizing and analysis of thermodynamic power cycles." It's a python package. From the paper:

MCycle allows users to analyse thermodynamic power cycles and their individual com- ponents, as well as size cycle components to de ned cycle design parameters. It was developed due to a need for an open source tool with easy scripting for sizing heat ex- changers that would allow control over individual component parameters. Users may now analyse a growing collection of thermodynamic power cycles and cycle components, including heat exchangers, expanders, compressors, heaters and coolers. Each type of component has models of varying complexity, allowing MCycle to be equally applica- ble to simplistic cycle analyses as to detailed sizing optimisations. The project page is found at https://github.com/momargoh/MCycle and the documentation is hosted at https://mcycle.readthedocs.io.

To evaluate a cycle’s fluid properties, MCycle uses the Python wrapper of the open-source thermodynamic properties library CoolProp (Bell et al. 2014). A library of heat transfer and component analysis methods is provided , containing theoretical relations and semi- empirical correlations sourced from published research articles (refer to the documentation for specific references).

[engnadeau]

@katyhuff I would love to, but I cannot fit it in my current schedule and give it the proper review it deserves.

However, if no one else is available, I may be able to find time in the coming weeks.

[trallard]

Hi @katyhuff apologies for the delay in replying. I would very much like to help with this. Unfortunately, I am very busy at the moment and I am afraid I cannot commit right now

[kyleniemeyer]

@katyhuff I'd like to help with this, but I'm totally slammed at the moment... getting nasty emails about other reviews that are weeks overdue 😩

I may have one or two colleagues (or their grad students) who could take a look—I will ping them and let you know.

[kyleniemeyer]

Hi @katyhuff, @puncan has agreed via email to review this submission.

[katyhuff]

Thanks @puncan @kyleniemeyer !

[katyhuff]

@whedon assign @puncan as reviewer

[whedon]

OK, the reviewer is @puncan

[katyhuff]

@whedon generate pdf

[whedon]

Attempting PDF compilation. Reticulating splines etc...

[whedon]

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

[katyhuff]

@whedon start review magic-word=bananas

[katyhuff]

@whedon start review magic-word=bananas

[whedon]

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

[katyhuff]

Ok @puncan @momargoh , let's head over to #710 for the review.

[kyleniemeyer]

@tabeel also just agreed to review, if you'd like an additional set of eyes