question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[JOSS Review] Test requirements

See original GitHub issue

This 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:closed
  • Created 2 years ago
  • Comments:9

github_iconTop GitHub Comments

1reaction
PhilipVinccommented, Jul 12, 2021

@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 does pip 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 invoke pytest && mpirun -np 2 pytest

0reactions
1313ecommented, Jul 14, 2021

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.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found