Cleanup 'usecases'. (#1294)

The new structure is to have one directory per keyword. Tests can be organized in separate test files, named test_*.py (or simulate.py if that's a better name).

Numerous tests have been polished to make them easier to read, using better names and functions to extract common functionality.

packaging/test_wheel.bash

@@ -34,7 +34,7 @@ test_wheel () {
         nmodl -o "${OUTPUT_DIR}" "${mod}" sympy --analytic
         $python_exe -c "import nmodl; driver = nmodl.NmodlDriver(); driver.parse_file('${mod}')"
     done
-    $python_exe -m pytest -vvv "${this_dir}/../test/"
+    $python_exe -m pytest -vvv --ignore "${this_dir}/../test/usecases" "${this_dir}/../test/"
 }
 
 echo "== Testing $python_wheel using $python_exe ($python_ver) =="

test/usecases/CMakeLists.txt

@@ -1,20 +1,20 @@
 set(NMODL_USECASE_DIRS
-    cnexp_scalar
-    cnexp_array
-    func_proc
-    func_proc_pnt
-    global_breakpoint
+    cnexp
+    function
+    procedure
+    global
     hodgkin_huxley
     nonspecific_current
     neuron_variables
+    net_event
+    net_move
     net_receive
     net_send
     point_process
     parameter
-    func_in_breakpoint
     suffix
     table
-    recursion)
+    useion)
 
 foreach(usecase ${NMODL_USECASE_DIRS})
   add_test(NAME usecase_${usecase}

test/usecases/cnexp_array/leonhard.mod → test/usecases/cnexp/cnexp_array.mod

@@ -1,5 +1,5 @@
 NEURON {
-    SUFFIX leonhard
+    SUFFIX cnexp_array
     RANGE z
 }
 

test/usecases/cnexp_scalar/leonhard.mod → test/usecases/cnexp/cnexp_scalar.mod

@@ -1,5 +1,5 @@
 NEURON {
-  SUFFIX leonhard
+    SUFFIX cnexp_scalar
 }
 
 STATE { x }

test/usecases/cnexp_array/simulate.py → test/usecases/cnexp/test_array.py

@@ -6,10 +6,10 @@
 nseg = 1
 
 s = h.Section()
-s.insert("leonhard")
+s.insert("cnexp_array")
 s.nseg = nseg
 
-x_hoc = h.Vector().record(s(0.5)._ref_x_leonhard)
+x_hoc = h.Vector().record(s(0.5)._ref_x_cnexp_array)
 t_hoc = h.Vector().record(h._ref_t)
 
 h.stdinit()
@@ -24,4 +24,3 @@
 rel_err = np.abs(x - x_exact) / x_exact
 
 assert np.all(rel_err < 1e-12)
-print("leonhard: success")

test/usecases/cnexp_scalar/simulate.py → test/usecases/cnexp/test_scalar.py

@@ -6,10 +6,10 @@
 nseg = 1
 
 s = h.Section()
-s.insert("leonhard")
+s.insert("cnexp_scalar")
 s.nseg = nseg
 
-x_hoc = h.Vector().record(s(0.5)._ref_x_leonhard)
+x_hoc = h.Vector().record(s(0.5)._ref_x_cnexp_scalar)
 t_hoc = h.Vector().record(h._ref_t)
 
 h.stdinit()
@@ -24,4 +24,3 @@
 rel_err = np.abs(x - x_exact) / x_exact
 
 assert np.all(rel_err < 1e-12)
-print("leonhard: success")

test/usecases/function/functions.mod

@@ -0,0 +1,24 @@
+NEURON {
+    SUFFIX functions
+    RANGE x
+}
+
+ASSIGNED {
+    x
+}
+
+FUNCTION x_plus_a(a) {
+    x_plus_a = x + a
+}
+
+FUNCTION v_plus_a(a) {
+    v_plus_a = v + a
+}
+
+FUNCTION identity(v) {
+    identity = v
+}
+
+INITIAL {
+    x = 1.0
+}

test/usecases/function/point_functions.mod

@@ -0,0 +1,24 @@
+NEURON {
+    POINT_PROCESS point_functions
+    RANGE x
+}
+
+ASSIGNED {
+    x
+}
+
+FUNCTION x_plus_a(a) {
+    x_plus_a = x + a
+}
+
+FUNCTION v_plus_a(a) {
+    v_plus_a = v + a
+}
+
+FUNCTION identity(v) {
+    identity = v
+}
+
+INITIAL {
+    x = 1.0
+}

test/usecases/function/recursion.mod

@@ -0,0 +1,11 @@
+NEURON {
+    SUFFIX recursion
+}
+
+FUNCTION fibonacci(n) {
+    if (n == 0 || n == 1) {
+        fibonacci = 1
+    } else {
+        fibonacci = fibonacci(n-1) + fibonacci(n-2)
+    }
+}

test/usecases/function/test_functions.py

@@ -0,0 +1,40 @@
+from neuron import h
+
+
+def check_functions(get_instance):
+    for x, value in zip(coords, values):
+        get_instance(x).x = value
+
+    for x, value in zip(coords, values):
+        expected = 100.0 + value
+        actual = get_instance(x).x_plus_a(100.0)
+        assert actual == expected, f"{expected} != {actual}"
+
+    x = coords[0]
+    v0 = -42.0
+    h.finitialize(v0)
+
+    # Check `f(v)`.
+    expected = 42.0
+    actual = get_instance(x).identity(expected)
+    assert actual == expected, f"{actual} == {expected}"
+
+    # Check `f` using `v`.
+    expected = -2.0
+    actual = get_instance(x).v_plus_a(40.0)
+    assert actual == expected, f"{actual} == {expected}"
+
+
+nseg = 5
+s = h.Section()
+s.nseg = nseg
+
+s.insert("functions")
+
+coords = [(0.5 + k) * 1.0 / nseg for k in range(nseg)]
+values = [0.1 + k for k in range(nseg)]
+
+point_processes = {x: h.point_functions(s(x)) for x in coords}
+
+check_functions(lambda x: s(x).functions)
+check_functions(lambda x: point_processes[x])

test/usecases/function/test_recursion.py

@@ -0,0 +1,15 @@
+import math
+
+import numpy as np
+from neuron import gui
+from neuron import h
+
+
+s = h.Section(name="soma")
+s.insert("recursion")
+
+n = 6
+actual = [s(0.5).recursion.fibonacci(i) for i in range(n)]
+expected = [1, 1, 2, 3, 5, 8]
+
+assert actual == expected, f"{actual} != {expected}"

test/usecases/global_breakpoint/leonhard.mod → test/usecases/global/read_only.mod

@@ -1,5 +1,5 @@
 NEURON {
-    SUFFIX leonhard
+    SUFFIX read_only
     GLOBAL c
 }
 

test/usecases/global_breakpoint/simulate.py → test/usecases/global/test_read_only.py

@@ -6,10 +6,10 @@
 nseg = 1
 
 s = h.Section()
-s.insert("leonhard")
+s.insert("read_only")
 s.nseg = nseg
 
-x_hoc = h.Vector().record(s(0.5)._ref_x_leonhard)
+x_hoc = h.Vector().record(s(0.5)._ref_x_read_only)
 t_hoc = h.Vector().record(h._ref_t)
 
 h.stdinit()
@@ -24,4 +24,3 @@
 abs_err = np.abs(x - x_exact)
 
 assert np.all(abs_err < 1e-12), f"{abs_err=}"
-print("leonhard: success")

test/usecases/parameter/test_parameter.mod → test/usecases/parameter/range_parameter.mod

@@ -1,5 +1,5 @@
 NEURON {
-    POINT_PROCESS test_parameter
+    POINT_PROCESS range_parameter
     RANGE x, y
 }
 

test/usecases/parameter/test_range_parameter.py

@@ -0,0 +1,24 @@
+import numpy as np
+
+from neuron import h, gui
+from neuron.units import ms
+
+s = h.Section()
+
+pp = h.range_parameter(s(0.5))
+
+# Defaults set in the PARAMETER block:
+assert pp.x == 42.0
+assert pp.y == 0.0
+
+# Assignable:
+pp.x = 42.1
+assert pp.x == 42.1
+
+h.stdinit()
+h.tstop = 5.0 * ms
+h.run()
+
+# Values (not) set during the INITIAL block:
+assert pp.x == 42.1
+assert pp.y == 43.0

test/usecases/point_process/pp.mod

@@ -0,0 +1,3 @@
+NEURON {
+    POINT_PROCESS pp
+}