Review of
"Southern Ocean deep mixing band emerges from a competition between winter buoyancy loss and upper stratification strength"

Review of "Southern Ocean deep mixing band emerges from a competition between winter buoyancy loss and upper stratification strength"

Submitted by jwallwork  

March 12, 2024, 5:06 p.m.

Lead reviewer

jakharkaran

Review team members

jwallwork

Review Body

Reproducibility

Did you manage to reproduce it?
Not Reproducible
Reproducibility rating
How much of the paper did you manage to reproduce?
2 / 10
Briefly describe the procedure followed/tools used to reproduce it

I failed to install dependencies or reproduce figures. Although, it likely is reproducible using Apptainer - unfortunately it doesn't work on arm64 processors.

Briefly describe your familiarity with the procedure/tools used by the paper.

I am unfamiliar with the libraries poetry and snakemake used in this work.

Which type of operating system were you working in?
Apple Operating System (macOSX)
What additional software did you need to install?

arm64 (Mac): poetry and pyproj packages needed to be installed which had dependency issues.

What software did you use

poetry pyproj

What were the main challenges you ran into (if any)?

The main challenge was installing poetry. Poetry uses a depreciated version of pyproj - which in turn needs specific version of python installed. Could not manage to get these working.

What were the positive features of this approach?

Looking at the documentation, very few dependencies needed to be installed to make the project work, If I hadn't had trouble installing poetry, things may have worked swiftly.

Any other comments/suggestions on the reproducibility approach?

Documentation

Documentation rating
How well was the material documented?
7 / 10
How could the documentation be improved?
  • Include the requirement of python version.
  • Suggest a workaround of installing in pyproj for different systems, Linux/Windows/Mac.
  • Include systems OS/hardware this code has worked on.

-Minor typo in instructions - poetyr. - Apptainer needs intel architechure - can't install on arm (new Macs) architecture (would help mentioning this in the documentation) - README.md says "You need to register and provide credentials for downloading ARMOR3D and ECCO." But where?

What do you like about the documentation?
  • It contains detailed instructions for installing all the dependencies.
  • It also includes workarounds if particular errors are thrown while trying to install them.
  • A single command can reproduce all the data/figures (given data is downloaded)
After attempting to reproduce, how familiar do you feel with the code and methods used in the paper?
6 / 10
Any suggestions on how the analysis could be made more transparent?

Reusability

Reusability rating
Rate the project on reusability of the material
7 / 10
Permissive Data license included:  
Permissive Code license included:  

Any suggestions on how the project could be more reusable?


Any final comments