Removing run-tests.py mentions (#4628)

* Removing mentions of run-tests.py Signed-off-by: Pradyot Ranjan <[email protected]> * Usin pytest instead of run-tests mentions Signed-off-by: Pradyot Ranjan <[email protected]> --------- Signed-off-by: Pradyot Ranjan <[email protected]> Co-authored-by: Pradyot Ranjan <[email protected]> Co-authored-by: Eric G. Kratz <[email protected]>
pybamm-team · Nov 28, 2024 · ad3a3fe · ad3a3fe
1 parent a9ceff9
commit ad3a3fe
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 14 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -15,10 +15,10 @@ Please add a line in the relevant section of [CHANGELOG.md](https://github.com/p
 # Key checklist:
 
 - [ ] No style issues: `$ pre-commit run` (or `$ nox -s pre-commit`) (see [CONTRIBUTING.md](https://github.com/pybamm-team/PyBaMM/blob/develop/CONTRIBUTING.md#installing-and-using-pre-commit) for how to set this up to run automatically when committing locally, in just two lines of code)
-- [ ] All tests pass: `$ python run-tests.py --all` (or `$ nox -s tests`)
-- [ ] The documentation builds: `$ python run-tests.py --doctest` (or `$ nox -s doctests`)
+- [ ] All tests pass: `$ python -m pytest` (or `$ nox -s tests`)
+- [ ] The documentation builds: `$ python -m pytest --doctest-plus src` (or `$ nox -s doctests`)
 
-You can run integration tests, unit tests, and doctests together at once, using `$ python run-tests.py --quick` (or `$ nox -s quick`).
+You can run integration tests, unit tests, and doctests together at once, using `$ nox -s quick`.
 
 ## Further checks:
 

diff --git a/docs/source/user_guide/installation/install-from-source.rst b/docs/source/user_guide/installation/install-from-source.rst
@@ -237,31 +237,27 @@ Finally, to run the unit and the integration suites sequentially, use
 
 	nox -s tests
 
-Using the test runner
+Using pytest
 ~~~~~~~~~~~~~~~~~~~~~~
 
 You can run unit tests for PyBaMM using
 
 .. code:: bash
 
 	  # in the PyBaMM/ directory
-	  python run-tests.py --unit
+	  pytest -m unit
 
 
-The above starts a sub-process using the current python interpreter (i.e. using your current
-Python environment) and run the unit tests. This can take a few minutes.
+The above uses pytest (in your current
+Python environment) to run the unit tests. This can take a few minutes.
 
-You can also use the test runner to run the doctests:
+You can also use pytest to run the doctests:
 
 .. code:: bash
 
-	  python run-tests.py --doctest
+	  pytest --doctest-plus src
 
-There is more to the PyBaMM test runner. To see a list of all options, type
-
-.. code:: bash
-
-	  python run-tests.py --help
+Refer to the `testing <https://docs.pybamm.org/en/stable/source/user_guide/contributing.html#testing>`_ docs to find out more ways to test PyBaMM using pytest.
 
 How to build the PyBaMM documentation
 -------------------------------------