Skip to content

Commit 3ba71fd

Browse files
authored
Update development_environment.rst (#575)
1 parent b2d49f6 commit 3ba71fd

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

docs/development/development_environment.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Ensure pre-commit is configured by running the following command:
2424
Running Tests
2525
=======================
2626
Assuming matlab is installed locally, and `k-wave <https://github.com/ucl-bug/k-wave>` is installed in a parallel directory, testing can be performed using the make file located in the project root.
27+
2728
.. code-block:: bash
2829
2930
make test
@@ -43,7 +44,9 @@ To run the tests with coverage, use the following command:
4344
coverage run
4445
4546
To run all examples, to ensure they still run after changes use the following command:
47+
4648
.. code-block:: bash
49+
4750
make run-examples
4851
4952
or
@@ -87,7 +90,7 @@ These tests are located in the ``tests`` directory. The comparison between ``mat
8790
#. Open desired example in matlab, e.g. `example_pr_2D_TR_directional_sensors.m <https://github.com/ucl-bug/k-wave/blob/main/k-Wave/examples/example_pr_2D_TR_directional_sensors.m>`_
8891
#. Find the lines where the call to one of the `kSpaceFirstOrder-family` function is made. For example,
8992

90-
.. code-block:: python
93+
.. code-block:: matlab
9194
9295
input_args = {'PMLInside', false, 'PMLSize', PML_size, 'PlotPML', false, 'Smooth', false};
9396
sensor_data = kspaceFirstOrder2D(kgrid, medium, source, sensor, input_args{:});

0 commit comments

Comments
 (0)