simplify test.py to only do regression tests (#117)

this also now returns the number of failures as the OS return code
so this can be used via a github action

Author: zingale

.github/workflows/regtest.yml

@@ -0,0 +1,48 @@
+name: regtest
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  regresion-tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Cache pip
+        uses: actions/cache@v3
+        with:
+          # this path is specific to Ubuntu
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Install pyro
+        run: python setup.py install --user
+
+      - name: Run tests via test.py
+        run: PYTHONPATH=$GITHUB_WORKSPACE ./test.py
+

README.md

@@ -1,13 +1,13 @@
-[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) 
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 [![pylint](https://github.com/python-hydro/pyro2/actions/workflows/pylint.yml/badge.svg)](https://github.com/python-hydro/pyro2/actions/workflows/pylint.yml)
 [![flake8](https://github.com/python-hydro/pyro2/actions/workflows/flake8.yml/badge.svg)](https://github.com/python-hydro/pyro2/actions/workflows/flake8.yml)
 [![pytest-all](https://github.com/python-hydro/pyro2/actions/workflows/pytest.yml/badge.svg)](https://github.com/python-hydro/pyro2/actions/workflows/pytest.yml)
 
-[![Documentation Status](https://readthedocs.org/projects/pyro2/badge/?version=latest)](https://pyro2.readthedocs.io/en/latest/?badge=latest) 
+[![Documentation Status](https://readthedocs.org/projects/pyro2/badge/?version=latest)](https://pyro2.readthedocs.io/en/latest/?badge=latest)
 
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/python-hydro/pyro2/main?filepath=examples%2Fexamples.ipynb) 
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/python-hydro/pyro2/main?filepath=examples%2Fexamples.ipynb)
 
-[![JOSS status](http://joss.theoj.org/papers/6d8b2f94e6d08a7b5d65e98a948dcad7/status.svg)](http://joss.theoj.org/papers/6d8b2f94e6d08a7b5d65e98a948dcad7) 
+[![JOSS status](http://joss.theoj.org/papers/6d8b2f94e6d08a7b5d65e98a948dcad7/status.svg)](http://joss.theoj.org/papers/6d8b2f94e6d08a7b5d65e98a948dcad7)
 [![DOI](https://zenodo.org/badge/20570861.svg)](https://zenodo.org/badge/latestdoi/20570861)
 
 
@@ -246,15 +246,14 @@ with their data.
 
   The `test.py` script will run several of the problems (as well as some
   stand-alone multigrid tests) and compare the solution to stored
-  benchmarks (in each solver's `tests/` subdirectory).
+  benchmarks (in each solver's `tests/` subdirectory).  The return value
+  of the script is the number of tests that failed.
 
-  It will also invoke the python `pytest` module to run the unit tests
-  for the different modules in pyro.
-
-  Tests are run nightly and reported here:
-
-  http://bender.astro.sunysb.edu/hydro_by_example/download/_stage/pyro2/tests.out
+  Unit tests are controlled by pytest and can be run simply via
 
+  ```
+  pytest .
+  ```
 
 ## Acknowledgements
 

examples/multigrid/mg_test_general_alphabeta_only.py

@@ -70,7 +70,7 @@ def f(x, y):
             16.0*np.pi**2 + 1.0)*np.sin(2*np.pi*x)*np.sin(2*np.pi*y)
 
 
-def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False,
+def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False, bench_dir="tests/",
                                    make_plot=False, verbose=1, rtol=1.e-12):
     """
     test the general MG solver.  The return value
@@ -173,7 +173,6 @@ def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False,
 
     # store the output for later comparison
     bench = "mg_general_poisson_dirichlet"
-    bench_dir = os.environ["PYRO_HOME"] + "/multigrid/tests/"
 
     my_data = a.get_solution_object()
 

examples/multigrid/mg_test_general_beta_only.py

@@ -70,7 +70,7 @@ def f(x, y):
         np.sin(2*np.pi*x)*np.sin(2*np.pi*y)
 
 
-def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False,
+def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False, bench_dir="tests/",
                                    make_plot=False, verbose=1, rtol=1.e-12):
     """
     test the general MG solver.  The return value
@@ -173,7 +173,6 @@ def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False,
 
     # store the output for later comparison
     bench = "mg_general_poisson_dirichlet"
-    bench_dir = os.environ["PYRO_HOME"] + "/multigrid/tests/"
 
     my_data = a.get_solution_object()
 

examples/multigrid/mg_test_general_constant.py

@@ -56,7 +56,7 @@ def f(x, y):
     return -2.0*((1.0-6.0*x**2)*y**2*(1.0-y**2) + (1.0-6.0*y**2)*x**2*(1.0-x**2))
 
 
-def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False,
+def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False, bench_dir="tests/",
                                    make_plot=False, verbose=1, rtol=1.e-12):
     """
     test the general MG solver.  The return value
@@ -159,7 +159,6 @@ def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False,
 
     # store the output for later comparison
     bench = "mg_general_poisson_dirichlet"
-    bench_dir = os.environ["PYRO_HOME"] + "/multigrid/tests/"
 
     my_data = a.get_solution_object()
 

examples/multigrid/mg_test_general_dirichlet.py

@@ -75,7 +75,7 @@ def f(x, y):
             16.0*np.pi**2 + 1.0)*np.sin(2*np.pi*x)*np.sin(2*np.pi*y)
 
 
-def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False,
+def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False, bench_dir="tests/",
                                    make_plot=False, verbose=1, rtol=1.e-12):
     """
     test the general MG solver.  The return value
@@ -178,7 +178,6 @@ def test_general_poisson_dirichlet(N, store_bench=False, comp_bench=False,
 
     # store the output for later comparison
     bench = "mg_general_poisson_dirichlet"
-    bench_dir = os.environ["PYRO_HOME"] + "/multigrid/tests/"
 
     my_data = a.get_solution_object()
 

examples/multigrid/mg_test_general_inhomogeneous.py

@@ -89,7 +89,7 @@ def yl_func(x):
     return np.cos(np.pi*x/2.0)
 
 
-def test_general_poisson_inhomogeneous(N, store_bench=False, comp_bench=False,
+def test_general_poisson_inhomogeneous(N, store_bench=False, comp_bench=False, bench_dir="tests/",
                                        make_plot=False, verbose=1, rtol=1.e-12):
     """
     test the general MG solver.  The return value
@@ -196,7 +196,6 @@ def test_general_poisson_inhomogeneous(N, store_bench=False, comp_bench=False,
 
     # store the output for later comparison
     bench = "mg_general_poisson_inhomogeneous"
-    bench_dir = os.environ["PYRO_HOME"] + "/multigrid/tests/"
 
     my_data = a.get_solution_object()
 

examples/multigrid/mg_test_simple.py

@@ -36,7 +36,7 @@ def f(x, y):
     return -2.0*((1.0-6.0*x**2)*y**2*(1.0-y**2) + (1.0-6.0*y**2)*x**2*(1.0-x**2))
 
 
-def test_poisson_dirichlet(N, store_bench=False, comp_bench=False,
+def test_poisson_dirichlet(N, store_bench=False, comp_bench=False, bench_dir="tests/",
                            make_plot=False, verbose=1, rtol=1e-12):
 
     # test the multigrid solver
@@ -89,7 +89,6 @@ def test_poisson_dirichlet(N, store_bench=False, comp_bench=False,
 
     # store the output for later comparison
     bench = "mg_poisson_dirichlet"
-    bench_dir = os.environ["PYRO_HOME"] + "/multigrid/tests/"
 
     my_data = a.get_solution_object()
 

examples/multigrid/mg_test_vc_dirichlet.py

@@ -56,7 +56,7 @@ def f(x, y):
         np.sin(2*np.pi*x)*np.sin(2*np.pi*y)
 
 
-def test_vc_poisson_dirichlet(N, store_bench=False, comp_bench=False,
+def test_vc_poisson_dirichlet(N, store_bench=False, comp_bench=False, bench_dir="tests/",
                               make_plot=False, verbose=1, rtol=1.e-12):
     """
     test the variable-coefficient MG solver.  The return value
@@ -147,7 +147,6 @@ def test_vc_poisson_dirichlet(N, store_bench=False, comp_bench=False,
 
     # store the output for later comparison
     bench = "mg_vc_poisson_dirichlet"
-    bench_dir = os.environ["PYRO_HOME"] + "/multigrid/tests/"
 
     my_data = a.get_solution_object()
 

examples/multigrid/mg_test_vc_periodic.py

@@ -56,7 +56,7 @@ def f(x, y):
         np.sin(2*np.pi*x)*np.sin(2*np.pi*y)
 
 
-def test_vc_poisson_periodic(N, store_bench=False, comp_bench=False,
+def test_vc_poisson_periodic(N, store_bench=False, comp_bench=False, bench_dir="tests/",
                              make_plot=False, verbose=1, rtol=1.e-12):
     """
     test the variable-coefficient MG solver.  The return value
@@ -157,7 +157,6 @@ def test_vc_poisson_periodic(N, store_bench=False, comp_bench=False,
 
     # store the output for later comparison
     bench = "mg_vc_poisson_periodic"
-    bench_dir = os.environ["PYRO_HOME"] + "/multigrid/tests/"
 
     my_data = a.get_solution_object()