Skip to content

Commit af8977f

Browse files
committed
add documentation on contributing page
1 parent 99ff24b commit af8977f

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

docs/source/contributing.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,18 @@ that the both old and new tests pass successfully:
6969
7070
>> make tests
7171
72+
If you run PyLops-MPI with GPUs you may also do:
73+
74+
.. code-block:: bash
75+
76+
>> make tests_gpu
77+
78+
Additionally, if you have a NCCL-enabled environment, you may also check:
79+
80+
.. code-block:: bash
81+
82+
>> make tests_nccl
83+
7284
4. Make sure the ``examples`` python scripts are executed using 3 processes without any errors:
7385

7486
.. code-block:: bash
@@ -123,8 +135,11 @@ Project structure
123135
This repository is organized as follows:
124136

125137
* **pylops_mpi**: Python library containing various mpi linear operators.
126-
* **tests**: Set of tests using pytest-mpi.
138+
* **tests**: Set of tests using pytest-mpi for both CPU and GPU.
139+
* **tests_nccl** Set of tests for NCCL-enabled environment using pytest-mpi
127140
* **testdata**: Sample datasets used in tests and documentation.
128141
* **docs**: Sphinx documentation.
129142
* **examples**: Set of python script examples for each mpi linear operator to be embedded in documentation using sphinx-gallery.
130-
* **tutorials**: Set of python script tutorials to be embedded in documentation using sphinx-gallery.
143+
* **tutorials**: Set of python script tutorials (NumPy & MPI) to be embedded in documentation using sphinx-gallery.
144+
* **tutorials_cupy**: Same set of scripts as above but with CuPy & MPI
145+
* **tutorials_nccl**: Same set of scripts as above but with CuPy & NCCL

0 commit comments

Comments
 (0)