[JOSS REVIEW #2]
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- fortran, numpy, python
- Domain
- documentation
Research direction
Start with the JOSS review checklist, the provided example, and example/callback.py; inspect the example page and public routines for the missing guidance. Verify whether the callback error is dependency-specific, then define completion as documented dependency verification, usable documentation beyond the example, and docstrings for public routines.
Written by the indexing model from the issue text.
Description
Hello,
this is the second round of review at https://github.com/openjournals/joss-reviews/issues/8992
apologies for my delay.
All concerns raised in the first review (#19) have been properly addressed.
The concern regarding data copies now seems fine, although the wording would probably be more direct/transparent to say copy instead of keepref/readonly, but this is really just personal choice, and should not have an impact on the work.
I have tested the reviewed code on two machines. On my laptop the example previously took 12s, after revision it takes 6s, and produces some error during the run:
>>> callback (Py): scanning along var_of_t04.t2ar02[:,2], ivar04 =
1004 1004 1004 1004 1004 1004
>>> callback (Py): scanning along var_of_t04.t2ar02[1:5,:], ivar04 =
Exception ignored on calling ctypes callback function: <function callback at 0x747f7dc3a200>
Traceback (most recent call last):
File "/home/mgunde/dl_py2f-example_resub/example/callback.py", line 242, in callback
print(a.ivar04, end=' ')
AttributeError: 'numpy.ndarray' object has no attribute 'ivar04'
On a different machine however I do see the claimed speedup, without any errors in the provided example code. Thus most probably the issue is from my laptop (probably related to version of some dependency, maybe numpy?).
Some bullet points from the JOSS review checklist do not seem to be satisfied though:
- There does not seem to be a mechanism for checking dependency installation/verification;
- The only way one can understand how to use the code is by working through the example page and the actual code, no other documentation seems to be available;
- The code itself is practically not commented, no help strings (docstrings) are available for the public routines/functions;
- Dominant language
- Python
- Stars
- 4
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
area:docs documentation effort:M ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
mczielinski/ob-analytics#423 ·
Maintainers usually reply within 1 day
-
needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
gke-labs/kube-agents#4838 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
danyuchn/asd-ste100-skill#60 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 64/100
Gathin23/cleanyourtv#3299 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
autowarefoundation/autoware_carla_scenario#1485 ·
Maintainers usually reply within 1 day