doc

src/gemini3d/job.py

@@ -9,6 +9,7 @@
 import logging
 import subprocess
 import shutil
+from math import prod
 from pathlib import Path, PurePosixPath
 import numpy as np
 
@@ -19,14 +20,20 @@
 from . import wsl
 from .utils import git_meta
 
-try:
-    from math import prod
-except ImportError:
-    # python < 3.8
-    from numpy import prod  # type: ignore
-
 
 def runner(pr: dict[str, typing.Any]) -> None:
+    """
+    setup simulation inputs and run Gemini3D in parallel using MPI
+
+    if you just want to setup the simulation, use
+
+        gemini3d.model.setup()
+
+    or
+
+        python -m gemini3d.model
+
+    """
     out_dir = check_outdir(pr["out_dir"])
 
     config_file = find.config(pr["config_file"])

src/gemini3d/utils.py

@@ -22,8 +22,6 @@
 
 def get_pkg_file(package: str, filename: str) -> Path:
     """Get a file from a package.
-    This function works for Python 3.7, 3.8 using a deprecated method,
-    and uses the recommended method for Python >= 3.9
 
     Parameters
     ----------