openjournals / jose-reviews

Reviews for the Journal of Open Source Education (JOSE)
http://jose.theoj.org
Creative Commons Zero v1.0 Universal
33 stars 4 forks source link

[REVIEW]: The Argo Online School: An e-learning tool to get started with Argo #193

Open whedon opened 1 year ago

whedon commented 1 year ago

Submitting author: !--author-handle-->@Alberto-GS<!--end-author-handle-- (Alberto González) Repository: https://github.com/euroargodev/argoonlineschool Branch with paper.md (empty if default branch): Version: 1.0 Editor: !--editor-->@kls2177<!--end-editor-- Reviewers: @francispoulin, @djmallum Archive: Pending

Status

status

Status badge code:

HTML: <a href="https://jose.theoj.org/papers/b66eaed8751b3adb6f2f4ad146380818"><img src="https://jose.theoj.org/papers/b66eaed8751b3adb6f2f4ad146380818/status.svg"></a>
Markdown: [![status](https://jose.theoj.org/papers/b66eaed8751b3adb6f2f4ad146380818/status.svg)](https://jose.theoj.org/papers/b66eaed8751b3adb6f2f4ad146380818)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@francispoulin, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

  1. Make sure you're logged in to your GitHub account
  2. Be sure to accept the invite at this URL: https://github.com/openjournals/jose-reviews/invitations

The reviewer guidelines are available here: https://openjournals.readthedocs.io/en/jose/reviewer_guidelines.html. Any questions/concerns please let @kls2177 know.

Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest

Review checklist for @francispoulin

Conflict of interest

Code of Conduct

General checks

Documentation

Pedagogy / Instructional design (Work-in-progress: reviewers, please comment!)

JOSE paper

Reviewer instructions & questions

@djmallum, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

  1. Make sure you're logged in to your GitHub account
  2. Be sure to accept the invite at this URL: https://github.com/openjournals/jose-reviews/invitations

The reviewer guidelines are available here: https://openjournals.readthedocs.io/en/jose/reviewer_guidelines.html. Any questions/concerns please let @kls2177 know.

Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest

Review checklist for @djmallum

Conflict of interest

Code of Conduct

General checks

Documentation

Pedagogy / Instructional design (Work-in-progress: reviewers, please comment!)

JOSE paper

whedon commented 1 year ago

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @francispoulin @djmallum it looks like you're currently assigned to review this paper :tada:.

:warning: JOSS reduced service mode :warning:

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

:star: Important :star:

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/jose-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

  1. Set yourself as 'Not watching' https://github.com/openjournals/jose-reviews:

watching

  1. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

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

@whedon commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf
whedon commented 1 year ago

Wordcount for paper.md is 1382

whedon commented 1 year ago

:point_right::page_facing_up: Download article proof :page_facing_up: View article proof on GitHub :page_facing_up: :point_left:

whedon commented 1 year ago
Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.52 s (83.2 files/s, 46540.9 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Jupyter Notebook                30              0          21967            746
JSON                             3              0              0            635
Markdown                         5            163              0            244
YAML                             4             22             12            123
TeX                              1             16              4            116
-------------------------------------------------------------------------------
SUM:                            43            201          21983           1864
-------------------------------------------------------------------------------

Statistical information for the repository 'd2d0fabea262cbb9e09e0c6a' was
gathered on 2023/01/23.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
Pedro Velez                     27         27542          28260           64.49
PedroVelez                      15         15719          15001           35.51

Below are the number of rows from each author that have survived and are still
intact in the current revision:

Author                     Rows      Stability          Age       % in comments
whedon commented 1 year ago
Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.17882/42182 is OK
- 10.5281/zenodo.4539666 is OK
- 10.3389/fmars.2019.00439 is OK
- 10.1038/nclimate2872 is OK
- 10.1038/nclimate2872 is OK
- 10.1175/JTECH-D-19-0041.1 is OK
- 10.21105/joss.02425 is OK

MISSING DOIs

- None

INVALID DOIs

- None
PedroVelez commented 1 year ago

Dear @kls2177 on October 23rd we got from @labarba the following comments:

"hi @Alberto-GS and @PedroVelez 👋 Thank you for your patience. I did not receive a reply from the editor we initially assigned to this submission, despite several emails and DMs. (People have generally been much harder to reach in the past 2.5 years, and one can never know what is affecting them.) The good news is that JOSE had a campaign to recruit new editors, and we have 7 editors joining the board as we speak! (They need to be onboarded, though.)

In the meantime, I had a fresh look at the submission, in more depth, and let me anticipate a few things.

(1) About the videos: note that JOSE considers videos as supplementary material that we do not review. I did notice that you have the videos on Google Drive, and for me they did not play on JupyterBook, as you have embedded them. It needed a "pop-out" to Drive. Have you considered putting them in a YouTube channel? (Perhaps unlisted? Vimeo is also an option). Then using from IPython.display import YouTubeVideo they will be playable in the Jupyter notebook (and JupyterBook?).

(2) On your paper, a reader has to wonder what Argos is all the way to the "Statement of Need," so I think that first paragraph there should be moved to the top of the Introduction.

(3) Regarding the audience, you mention high-school students, which called my attention. Is there any experience involving high-school students in this topic? Do you have any experiences with different student populations that you could tell us about?

(*) We do not review videos, or slide presentations, or other forms of OCW, because they cannot be modified or easily reused. JOSE reviews open-source material that is reusable and allows derived works. Also, when you make an archive of the repository (source files for the JupyterBook), the videos will not be included."

we are working in these comments and shortly we will reply to them in this issue.

PedroVelez commented 1 year ago

Hi,

regarding the first topic (1), we have tested versions using YouTube (see here https://euroargodev.github.io/argo-online-school/Lessons/L01_TheArgoProgram/Chapter10_TheArgoProgram_intro.html ), however we do not like this option since YouTube will suggest new videos that distract the 'reader' from the school. And, as far as we know there is not way, either using IPython or an iframe within the markdown, to avoid this distraction. We have no tested Vimeo but probably is similar, since thew platform will promotes its own videos.

In general the Lesson1 and Lesson2 are meant to be seen in the main web page https://euroargodev.github.io/argoonlineschool/intro.html and Lesson 3 is the one to be downloaded to work with the Jupyter notebooks.

Please @kls2177 if you have another suggestion we will happy to test it. best Pedro

Alberto-GS commented 1 year ago

Hi all,

About (2), the "Statement of Need" has been placed where suggested.

About (3), we don't have previous experiences but this audience escope was proposed because here (at least in Spain) highschool students and first grade college students already have coding notions. We sadly don't have feedback with different student populations:( Do you find this scope audience too optimistic? Do you think it should be modified? @kls2177 @labarba

I just realized there is an error in our affilitaion (probably my bad) artice proof . It should be "Centro Oceanográfico de Canarias, Instituto Español de Oceanografía (IEO - CSIC)"

Thanks!

labarba commented 1 year ago

@whedon add @gaelforget as reviewer

whedon commented 1 year ago

OK, @gaelforget is now a reviewer

kls2177 commented 1 year ago

Hi @Alberto-GS and @PedroVelez,

Thank you for your patience. Reviewers have now been assigned.

Regarding the videos, I am able to view them and I think using Youtube is the easiest way to proceed. However, please keep in mind "We do not review videos, or slide presentations, or other forms of OCW, because they cannot be modified or easily reused. JOSE reviews open-source material that is reusable and allows derived works. Also, when you make an archive of the repository (source files for the JupyterBook), the videos will not be included."

Regarding your audience, I suggest that you focus on the audience that this material was originally intended for rather than speculating as to who it could potentially be for.

I hope this helps!

whedon commented 1 year ago

:wave: @bzemskova, please update us on how your review is going (this is an automated reminder).

kls2177 commented 1 year ago

Hello @bzemskova and @gaelforget, how is the review process going?

kls2177 commented 1 year ago

Hello @bzemskova and @gaelforget, since we have not hard from you in several weeks, we are now looking for new reviewers. Thank you for your original willingness to contribute a review.

kls2177 commented 1 year ago

@whedon remove @bzemskova as reviewer

whedon commented 1 year ago

OK, @bzemskova is no longer a reviewer

kls2177 commented 1 year ago

@whedon remove @gaelforget as reviewer

whedon commented 1 year ago

OK, @gaelforget is no longer a reviewer

kls2177 commented 1 year ago

@whedon add @francispoulin as reviewer

whedon commented 1 year ago

OK, @francispoulin is now a reviewer

kls2177 commented 1 year ago

@whedon add @djmallum as reviewer

whedon commented 1 year ago

OK, @djmallum is now a reviewer

francispoulin commented 1 year ago

I found a problem with one of the notebooks. I am going to post it here but if it's better to put it elsewhere, please let me know.

In L03-Chapter11_TheNetCDFFFormat, In [26], I get an error with the line ax.plot(dataOPsubsampled.sst)

francispoulin commented 1 year ago

In L03-Chapter22_ArgoDatabyFloat_Prof, in In [3]: the line should read as follows, otherwise the Data cannot be found and an error occurs,

prof = xr.open_dataset('../../Data/6901254/6901254_prof.nc').

francispoulin commented 1 year ago

In L03-Chapter31_ArgoDatabyData_Day, the following need to be changed.

In [3]: the first line should reference 2019, as that is what is found in the Data folder.

dayADS = xr.open_dataset('../../Data/atlantic_ocean/2019/11/20191111_prof.nc').

In [7]: again refer to 2019 data.

dayPDS = xr.open_dataset('../../Data/pacific_ocean/2019/11/20191111_prof.nc') dayIDS = xr.open_dataset('../../Data/indian_ocean/2019/11/20191111_prof.nc')

In [13]: 2019 not 2020.

for filein in ['../../Data/atlantic_ocean/2019/11/20191111_prof.nc', '../../Data/pacific_ocean/2019/11/20191111_prof.nc', '../../Data/indian_ocean/2019/11/20191111_prof.nc']:

More changes need to be made in this file I leave it to you to fix them.

francispoulin commented 1 year ago

In L03-Chapter32: there is problem with In [8], saying module 'argopy' has no attribute 'plotters'.

francispoulin commented 1 year ago

In L03-Chapter41:

In [4] should refer to 2019 not 2020.

In[ 13] has an error as another exception occured:.

francispoulin commented 1 year ago

Ln L03-Chapter42:

In [3]: has an error another exception occurred:.

francispoulin commented 1 year ago

This is an interesting contribution to the field that will be useful to many young researchers. I have pointed out a number of bugs that I found in the notebooks, but I presume these are easy to fix.

One general concern is that the first two lessons only involve watching videos and no actual python code. If that’s the case it’s nto clear the utility of including them in a notebook. I am okay with this but I feel like if there was some python in the first two lessons that might be better balanced.

Below are a few minor points that should be addressed.

• The version should be 1.0 but the tag shows it to be v0.1.0.
• The name is sometimes abreviated as AOS and other times AoS.  Either is fine but be consistant.
• On the main documentation page, when I click on 1. The Argo Program, I get a 404 error.
• The paper.md file does not have any references, however I do see them in the PDF.  I presume this is okay then but wanted to confirm before I click the box.
• You should point out this is useful to high school, undergraduate and graduate students.
djmallum commented 1 year ago

First, I'd like to thank the authors for this very interesting module. I agree with Francis that this is a very good contribution to the field and should be considered for publication after resolving the issues I've raised. Below, I'll link to my comments which I organized in a manner which I hope is convenient. Please feel free to ask me questions about any of my comments.

kls2177 commented 1 year ago

@Alberto-GS and @PedroVelez, the reviewers have completed their reviews and have comments for your consideration. I recommend that these comments be addressed before publication.

Thanks @francispoulin and @djmallum for your helpful comments. @djmallum, quick question - I do not see an issue on the argoonlineschool repo entitled "General Comments". Not sure if this got included elsewhere.

@francispoulin and @djmallum, would you be willing to review the revised version when available?

Just a few of my own comments: I agree with @francispoulin, that it would be nice to integrate some python examples earlier in the course. Perhaps, just some simple plotting examples - rather that providing some static images, ask the students to generate the plots using python. This would allow students who are learning python for the first time to get some gradual exposure before Lesson 3.

You mention that this material is for high school or graduate students - what about undergraduate students?

I do not necessarily agree with your statement that no pre-requisite knowledge is required. There are certainly expectations about general science and mathematics knowledge. I suggest providing some information about pre-requisite knowledge on the landing page of the Argo Online School website. For example, what pre-requisite oceanography, maths, chemistry, geography knowledge is expected of students? This is likely more relevant for high school students than post-secondary students. At the beginning of Lesson 3, you provide students with a link to the Earth and Environmental Data Science course to learn python if they need to, but it would be nice to provide students with information about these pre-requisite coding skills and resources at the beginning of the course.

I really like the interactive quizzes! These look great and give timely feedback to students. I would recommend integrating a few more of these at regular intervals to keep the students engaged. Structurally, I would also suggest embedding the quizzes into each lesson, rather than having them as a separate section at the end. I feel that this would better reflect the sequencing of the material.

Thank you for your patience! Please let me know if you have any questions.

djmallum commented 1 year ago

@kls2177 I must not have saved that issue properly. I should be able to resolve that today. I'm also happy to review the revised version when available.

djmallum commented 1 year ago

@kls2177 @Alberto-GS @PedroVelez I have now fixed the links above and added a "General Comments" issue in the target repository. I will be away until the 29th of May and will not be able to respond to questions until then, but I will be available for the rest of the day if anything comes up.

francispoulin commented 1 year ago

@kls2177 I am happy to review a revised version of the manuscript.

Alberto-GS commented 1 year ago

Hello everyone, Thank you very much for the entire revision process, which will undoubtedly enrich the manuscript. We take up the baton from now on to revise all the comments made and include them. Thanks!

kls2177 commented 1 year ago

Hi @Alberto-GS, how are the revisions going?

Alberto-GS commented 1 year ago

Hello @kls2177. On hold to be honest. While we waited for a response at the time, we focused our efforts on finishing a paper that was published precisely last week. I will start this week and you will hear from us soon:) Thank you so much for asking!

kls2177 commented 3 months ago

Hello @Alberto-GS, I am following up on this thread. Let me know if you will have some time to proceed with the revisions in the coming months. Thanks!

Alberto-GS commented 3 months ago

Hello @Alberto-GS, I am following up on this thread. Let me know if you will have some time to proceed with the revisions in the coming months. Thanks!

Hello! We haven't forgotten about this thread:) We are overwhelmed with work and long sick leave. I hope to be able to make changes very soon and let you know in the next few months! Thank you very much, really appreciate it. @PedroVelez

Alberto-GS commented 2 months ago

Hi @kls2177 I'm trying to resolve some serious bugs but I'm having trouble pushing all the commits https://github.com/euroargodev/argoonlineschool/actions Could you shed some light on the problem? I'm familiar with GitHub but I'm not very skilled. I've installed all the dependencies, packages and updates on my local computer and it seems to work just fine. In fact, I can see the changes correctly. Once I push it to the repository, I get this GitHub report containing errors. I'm guessing something is going on with HDF5 but I still don't know how to solve it after several hours of searching (it's probably just a silly thing). Thanks.

kls2177 commented 2 months ago

@Alberto-GS, I am not an expert either, but I will take a look at your logs. I may not have a chance until Thursday.

Alberto-GS commented 1 month ago

Hello @kls2177, after some checks @PedroVelez solved the bug. Apparently there was some issue between the workflow and the netCDF package. Now we're on the road again.

PedroVelez commented 1 month ago

Hi, thanks a lot for the patience @kls2177 we have all most ended including all the suggestions , we have replied to each of of them in the issues opened for the repository:

Typos Lesson 1 Lesson 2 Lesson 3 Checklist Comments (See above) General Comments

and we would like to know what do we have to do for re-submission.

thanks pedro

PedroVelez commented 1 month ago

@Alberto-GS and @PedroVelez, the reviewers have completed their reviews and have comments for your consideration. I recommend that these comments be addressed before publication.

Thanks @francispoulin and @djmallum for your helpful comments. @djmallum, quick question - I do not see an issue on the argoonlineschool repo entitled "General Comments". Not sure if this got included elsewhere.

@francispoulin and @djmallum, would you be willing to review the revised version when available?

Just a few of my own comments: I agree with @francispoulin, that it would be nice to integrate some python examples earlier in the course. Perhaps, just some simple plotting examples - rather that providing some static images, ask the students to generate the plots using python. This would allow students who are learning python for the first time to get some gradual exposure before Lesson 3.

You mention that this material is for high school or graduate students - what about undergraduate students?

I really like the interactive quizzes! These look great and give timely feedback to students. I would recommend integrating a few more of these at regular intervals to keep the students engaged. Structurally, I would also suggest embedding the quizzes into each lesson, rather than having them as a separate section at the end. I feel that this would better reflect the sequencing of the material.

  • [X] Thanks!, we have moved each quizz to the end of each lesson.
PedroVelez commented 1 month ago

Hi @francispoulin @kls2177 @djmallum we haver finished to do the review, including all the suggestions, typos and errors. Please could you let us now what is the next step? best pedro

labarba commented 1 month ago

Hi @PedroVelez — thank you for your patience, as everyone here is a volunteer, and doing their best! In my case, for example, the semester started and it is a hectic time. My response times are going to be delayed.

PedroVelez commented 1 month ago

Hi @labarba, of course, no rush. Thanks

kls2177 commented 3 weeks ago

Hello @PedroVelez and @Alberto-GS, I apologize for the delay. I was on vacation when the updates were coming in.

Thank you for responding to the reviewers comments. @francispoulin and @djmallum, I would now ask that you please take a look at the revisions and let me know whether you are satisfied and whether or not you would recommend the materials for publication.

Thanks to everyone for their patience!

francispoulin commented 3 weeks ago

I did a git pull of the repo and see that there is a problem in Chapter32.

When I execute the second cell I get a KeyError.

Can the authors please check if this works for them in the freshly pulled repo?

PedroVelez commented 3 weeks ago

Thanks for reviewing it!

There was a problem with the numpy version and xarray, therefore the numpy version has to be 1.26.4 until xarray fix the problem.

We have updated the environment.yml and verified that a clean installation of the enviroment, using

conda env create -n AOS -f environment.yml 
conda activate AOS

works. I know is very inconvenient, but in my experience this is often the case of python.

By the way, following some suggestion we have just added a section with more examples including one very similar to the ArgoStatus

best pedro

I did a git pull of the repo and see that there is a problem in Chapter32.

When I execute the second cell I get a KeyError.

Can the authors please check if this works for them in the freshly pulled repo?