Skip to content

added discussion of running mpi-pytest in the non-forking mode #609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 1, 2025
Merged

added discussion of running mpi-pytest in the non-forking mode #609

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ you will need the following packages:
* pooch >= 1.8
* pre-commit
* pytest
* mpi-pytest >= 2025.7.0
* pytest-cov >= 5.0
* pypandoc
* sphinx
Expand Down Expand Up @@ -196,6 +197,13 @@ Documentation on how to run simulations and developer API documentation is hoste
```
pytest
```
Note that this uses the forking mode of `mpi-pytest`, which is not supported on all operating systems. If the forking mode does not work, you will have to run the tests with different numbers of processes separately. Here is an example that runs all tests with 1 process, then runs all tests with 2 processes:
```
mpiexec -n 1 pytest -m parallel[1]
mpiexec -n 2 pytest -m parallel[2]
```
In the non-forking mode, wrapping pytest in an mpiexec call for the case of 1 process which includes tests not using mpi may not be necessary.

You can alternatively run `python -m pytest pyuvsim` or `python setup.py test`.
You will need to have all dependencies installed.

Expand Down
Loading