allow for "from pyro import Pyro" (#233)

Author: zingale

docs/source/compressible-convergence.ipynb

@@ -20,12 +20,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 19,
+   "execution_count": 1,
    "id": "0c19f42b-16f1-48a8-ba19-e07f5addabd1",
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pyro.pyro_sim import Pyro"
+    "from pyro import Pyro"
    ]
   },
   {
@@ -42,7 +42,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 20,
+   "execution_count": 2,
    "id": "90900ff2-27b5-4642-a1de-006a9a30d975",
    "metadata": {},
    "outputs": [],
@@ -216,7 +216,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.4"
+   "version": "3.12.5"
   }
  },
  "nbformat": 4,

docs/source/running.rst

@@ -65,12 +65,15 @@ Kelvin-Helmholtz problem ``kh``, we would do the following:
 
 .. code-block:: python
 
-    from pyro.pyro_sim import Pyro
+    from pyro import Pyro
     p = Pyro("compressible")
-    p.initialize_problem(problem_name="kh",
-                         inputs_file="inputs.kh")
+    p.initialize_problem(problem_name="kh")
     p.run_sim()
 
+This will use the default set of parameters for the problem specified
+in the inputs file defined by ``DEFAULT_INPUTS`` in the problem
+initialization module.
+
 Instead of using an inputs file to define the problem parameters, we can define a
 dictionary of parameters and pass them into the :func:`initialize_problem
 <pyro.pyro_sim.Pyro.initialize_problem>` function using the keyword argument ``inputs_dict``.
@@ -82,7 +85,6 @@ visualization for the previous example, we would do:
 
     parameters = {"vis.dovis": 0}
     p.initialize_problem(problem_name="kh",
-                         inputs_file="inputs.kh",
                          inputs_dict=parameters)
 
 It's possible to evolve the simulation forward timestep by timestep manually using

examples/examples.ipynb

@@ -15,7 +15,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pyro.pyro_sim import Pyro"
+    "from pyro import Pyro"
    ]
   },
   {

pyro/__init__.py

@@ -9,4 +9,5 @@
 
 from pyro.mesh import (BC, ArrayIndexer, ArrayIndexerFC, CellCenterData2d,
                        FaceCenterData2d, FV2d, Grid2d, RKIntegrator)
+from pyro.pyro_sim import Pyro
 from pyro.util import RuntimeParameters, TimerCollection

pyro/solver-test.ipynb

@@ -15,7 +15,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pyro.pyro_sim import Pyro"
+    "from pyro import Pyro"
    ]
   },
   {

pyro/solver_test_swe.ipynb

@@ -6,7 +6,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pyro.pyro_sim import Pyro\n",
+    "from pyro import Pyro\n",
     "solver = \"swe\""
    ]
   },

pyro/tests/test_pyro.py

@@ -1,7 +1,7 @@
 import numpy as np
 from numpy.testing import assert_array_equal
 
-from pyro.pyro_sim import Pyro
+from pyro import Pyro
 
 
 class TestSimulation: