review from UU course on reproducible code

[lilimelgar]

This is part of an exercise for the course "reproducible code" Utrecht University, February 24-25, 2022.

REPRODUCING CODE: WHAT DID YOU LEARN?

Go to the GitHub repository of the project you're reproducing -> Open an 'Issue' -> Copy all the text below the --- into that 'Issue' -> Start answering the questions there.

Hint: you can place an X within the square brackets to mark off a checkbox, like this: [X] Yes

---

1. What project did you reproduce (include the link)?

-> https://github.com/annaps96/pynta

2. Does the project have the following on it's GitHub repository?

• README
• A license (could be presented more succinctly perhaps?)
• Citation information (didn't find it...)
• Requirements for running the code (dependencies) (there are some requirements written, but, for me (novice) it was not clear whether I had to clone the repository (initial steps, perhaps obvious for experts? just looking at the guidelines I missed this).
• An understandable folder structure (the folder structure was complex for me (novice in coding). I did miss a src folder, perhaps name the folder "pynta" as "src_pynta"?. I also saw .py files in different folders.

3. What did you appreciate about the project's repository?

-> Very complete documentation (read the docs), illustrations, it looks like a very mature project!

4. Do you have any suggestions for improvement to the repository?

-> Yes, the "Wishlist" could be turned out into a Github issue with a tag (requested_feature). In that way, you don't get a long list in the Read.me file but have it all in the issues.
Also, how can people contribute to your project? When I cloned the repo I got a message asking: "how are you planning to use this fork?" Not sure if you want others to collaborate, but could be checked perhaps.

5. Did you manage to run the project successfully?

• Yes
• Largely
• No
• Other (please specify): I didn't install the virtual environment because I was afraid of messing up my own envs (I am not so fluent in doing this... sorry).

6. Where did you have to give up reproducing this repository (if applicable)?

-> In the installation of the env.

7. Did you have to go into the code?

• Yes
• No (as a novice this code is very complex to me, because there are several .py files in many folders. I am more used to a couple of scripts ;). Sorry...
• I didn't have to, but I had time left/was intrigued, so I did it anyway!

8. If you looked at the code: what did you like?

-> n.a.

9. If you looked at the code, what would be a single line of advice you want to pass on to it's author?

-> I am not an expert to say this, but perhaps put your .py files together and create the "main" to call them? not sure as I said, but to me it was a bit difficult to understand the folder structure and file naming system.

10. Any final comments to the author?

-> Your project looks amazing, best wishes!

11. Do you think the class will benefit from a live demo of the reproduction of this project? Why/what can we learn?

-> Perhaps the author could give the demo? I am sorry I couldn't fully reproduce it...