Skip to content

Correct paths of existing regression tests in unit test docstrings #4426

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

Open
timothy-nunn wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −10
Open

Correct paths of existing regression tests in unit test docstrings #4426

Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion documentation/source/development/numba.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ for more information.
from numba import njit
import numpy as np


@njit
def my_function(a, b):
c = a[0] + a[1]
Expand All @@ -47,6 +48,7 @@ But, also **cannot** do the following:
```python
from numba import njit


@njit
def my_other_function(n, data):
return n + data.superconducting_tfcoil.n_tf_coils
Expand Down Expand Up @@ -89,7 +91,7 @@ First ensure that `gprof2dot` is installed by issuing the command `pip install g
Execute the following commands from the PROCESS root directory:

```bash
> python3 -m cProfile -o large-tok.pstats process/main.py -i tests/regression/scenarios/large-tokamak/IN.DAT
> python3 -m cProfile -o large-tok.pstats process/main.py -i tests/regression/input_files/large_tokamak_nof.IN.DAT

> gprof2dot -f pstats large-tok.pstats | dot -Tpng -o large_tokamak_profile.png
```
Expand Down
14 changes: 7 additions & 7 deletions tests/unit/models/stellarator/test_stellarator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ def test_stgeom(stgeomparam, monkeypatch, stellarator):
Automatically generated Regression Unit Test for stgeom.

This test was generated using data from
tests/regression/scenarios/stellarator/IN.DAT.
tests/regression/input_files/helias_5b.IN.DAT.

:param stgeomparam: the data used to mock and assert in this test.
:type stgeomparam: stgeomparam
Expand Down Expand Up @@ -302,7 +302,7 @@ def test_stbuild(stbuildparam, monkeypatch, stellarator):
Automatically generated Regression Unit Test for st_build.

This test was generated using data from
tests/regression/scenarios/stellarator/IN.DAT.
tests/regression/input_files/helias_5b.IN.DAT.

:param stbuildparam: the data used to mock and assert in this test.
:type stbuildparam: stbuildparam
Expand Down Expand Up @@ -499,7 +499,7 @@ def test_ststrc(ststrcparam, monkeypatch, stellarator):
Automatically generated Regression Unit Test for ststrc.

This test was generated using data from
tests/regression/scenarios/stellarator/IN.DAT.
tests/regression/input_files/helias_5b.IN.DAT.

:param ststrcparam: the data used to mock and assert in this test.
:type ststrcparam: ststrcparam
Expand Down Expand Up @@ -1443,7 +1443,7 @@ def test_intersect(intersectparam):
Automatically generated Regression Unit Test for intersect.

This test was generated using data from
tests/regression/scenarios/stellarator/IN.DAT.
tests/regression/input_files/helias_5b.IN.DAT.

:param intersectparam: the data used to mock and assert in this test.
:type intersectparam: intersectparam
Expand Down Expand Up @@ -1508,7 +1508,7 @@ def test_stdlim(stdlimparam, monkeypatch, stellarator):
Automatically generated Regression Unit Test for stdlim.

This test was generated using data from
tests/regression/scenarios/stellarator/IN.DAT.
tests/regression/input_files/helias_5b.IN.DAT.

:param stdlimparam: the data used to mock and assert in this test.
:type stdlimparam: stdlimparam
Expand Down Expand Up @@ -1570,7 +1570,7 @@ def test_stdlim_ecrh(stdlimecrhparam, monkeypatch, stellarator):
Automatically generated Regression Unit Test for stdlim_ecrh.

This test was generated using data from
tests/regression/scenarios/stellarator_config/IN.DAT.
tests/regression/input_files/stellarator_helias.IN.DAT.

:param stdlimecrhparam: the data used to mock and assert in this test.
:type stdlimecrhparam: stdlimecrhparam
Expand Down Expand Up @@ -1665,7 +1665,7 @@ def test_st_calc_eff_chi(stcalceffchiparam, monkeypatch, stellarator):
Automatically generated Regression Unit Test for st_calc_eff_chi.

This test was generated using data from
tests/regression/scenarios/stellarator_config/IN.DAT.
tests/regression/input_files/stellarator_helias.IN.DAT.

:param stcalceffchiparam: the data used to mock and assert in this test.
:type stcalceffchiparam: stcalceffchiparam
Expand Down
4 changes: 2 additions & 2 deletions tests/unit/models/test_superconductors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def test_itersc(iterscparam):
Automatically generated Regression Unit Test for itersc.

This test was generated using data from
tests/regression/scenarios/large-tokamak/IN.DAT.
tests/regression/input_files/large_tokamak_nof.IN.DAT.

:param iterscparam: the data used to mock and assert in this test.
:type iterscparam: iterscparam
Expand Down Expand Up @@ -122,7 +122,7 @@ def test_jcrit_nbti(jcritnbtiparam):
Automatically generated Regression Unit Test for jcrit_nbti.

This test was generated using data from
tests/regression/scenarios/large-tokamak/IN.DAT.
tests/regression/input_files/large_tokamak_nof.IN.DAT.

:param jcritnbtiparam: the data used to mock and assert in this test.
:type jcritnbtiparam: jcritnbtiparam
Expand Down
Loading