[JOSS Review] Test requirements
See original GitHub issueThis issue is part of the JOSS Review in openjournals/joss-reviews#3419.
I would like to execute the tests in mpi4jax
, which use pytest
, on my desktop, but there are no instructions nor requirements available for performing these tests.
Could a list of requirements be added, either as a file that can be installed with pip install -r requirements_test.txt
, or simply adding it to the setup()
function in the setup.py
file?
Issue Analytics
- State:
- Created 2 years ago
- Comments:9
Top Results From Across the Web
Review criteria — JOSS documentation
Reviewers should verify that the software represents substantial scholarly effort. As a rule of thumb, JOSS' minimum allowable contribution should represent not ...
Read more >JOSS Documentation - Read the Docs
checklist and review criteria to better understand how your submission will ... test that your paper is going to compile properly for JOSS:....
Read more >About the Journal of Open Source Software
Scope & submission requirements JOSS submissions must: Be open source (i.e., have an OSI-approved license). Have an obvious research application.
Read more >[REVIEW]: CiteLang: Modeling the Research Software ...
These checklists contain the JOSS requirements. As you go over the submission, please check any items that you feel have been satisfied. The ......
Read more >Journal of Open Source Software (JOSS): design and first ...
2) by working through a checklist of review items, as described in Section 'JOSS review criteria'. The author, reviewer, and editor discussed any...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@1313e thanks for your review.
@dionhaefner is it ok if we go with adding an
extras_require={'dev':[pytest, black, precommit...]}
so that if one doespip install mpi4jax[dev]
then everything will work out of the box?PyTest is already set up to run the tests by simply invoking
pytest
so we might need to write in the documentation somewhere that you are supposed to invokepytest && mpirun -np 2 pytest
Might be a good idea to install the package using the described way from the online documentation in GitHub Actions, to make sure that there is a minimal difference between the user way and automated way of testing.