Use petsctools package (#4194)

* Add version_spec check to setup.py
* Move OptionsManager to petsctools

Author: connorjward

docs/source/conf.py

@@ -135,6 +135,7 @@
     (r'py:.*', r'ufl\..*'),
     (r'py:.*', r'PETSc\..*'),
     (r'py:.*', r'progress\..*'),
+    (r'py:.*', r'petsctools\..*'),
     # Ignore undocumented PyOP2
     ('py:class', 'pyop2.caching.Cached'),
     # Ignore mission docs from Firedrake internal "private" code

docs/source/optimising.rst

@@ -136,7 +136,7 @@ Caveats
 
   .. code-block:: python
 
-    from firedrake.petsc import OptionsManager
+    from petsctools import OptionsManager
 
     # If the -log_view flag is passed you don't need to call
     # PETSc.Log.begin because it is done automatically.

firedrake/__init__.py

@@ -1,24 +1,38 @@
-import sys
-from firedrake.configuration import setup_cache_dirs
+# The range of PETSc versions supported by Firedrake. Note that unlike in
+# firedrake-configure and pyproject.toml where we want to be strict about
+# the specific version, here we are more permissive. This is to catch the
+# case where users don't update their PETSc for a really long time or
+# accidentally install a too-new release that isn't yet supported.
+PETSC_SUPPORTED_VERSIONS = ">=3.23.0"
+
+
+def init_petsc():
+    import os
+    import sys
+    import petsctools
+
+    # We conditionally pass '-options_left no' as in some circumstances (e.g.
+    # when running pytest) PETSc complains that command line options are not
+    # PETSc options.
+    if os.getenv("FIREDRAKE_DISABLE_OPTIONS_LEFT") == "1":
+        petsctools.init(sys.argv + ["-options_left", "no"], version_spec=PETSC_SUPPORTED_VERSIONS)
+    else:
+        petsctools.init(sys.argv, version_spec=PETSC_SUPPORTED_VERSIONS)
+
+
+# Ensure petsc is initialised right away
+init_petsc()
 
 # Set up the cache directories before importing PyOP2.
+from firedrake.configuration import setup_cache_dirs
+
 setup_cache_dirs()
 
-# Ensure petsc is initialised by us before anything else gets in there.
-# We conditionally pass '-options_left no' as in some circumstances (e.g.
-# when running pytest) PETSc complains that command line options are not
-# PETSc options.
-import os
-import petsc4py
-if os.getenv("FIREDRAKE_DISABLE_OPTIONS_LEFT") == "1":
-    petsc4py.init(sys.argv + ["-options_left", "no"])
-else:
-    petsc4py.init(sys.argv)
-del os, petsc4py
 
 # Initialise PETSc events for both import and entire duration of program
+import petsctools
 from firedrake import petsc
-_is_logging = "log_view" in petsc.OptionsManager.commandline_options
+_is_logging = "log_view" in petsctools.OptionsManager.commandline_options
 if _is_logging:
     _main_event = petsc.PETSc.Log.Event("firedrake")
     _main_event.begin()
@@ -29,6 +43,7 @@
     import atexit
     atexit.register(lambda: _main_event.end())
     del atexit
+del petsctools
 del petsc
 
 from ufl import *
@@ -85,6 +100,7 @@
 #   from firedrake._deprecation import output
 #   sys.modules["firedrake.output"] = output
 from firedrake.output import *
+import sys
 sys.modules["firedrake.plot"] = plot
 from firedrake.plot import *
 
@@ -104,7 +120,7 @@ def set_blas_num_threads():
 
     """
     from ctypes import cdll
-    from firedrake.petsc import get_blas_library
+    from petsctools import get_blas_library
 
     try:
         blas_lib_path = get_blas_library()

firedrake/checkpointing.py

@@ -4,9 +4,10 @@
 import finat.ufl
 from pyop2 import op2
 from pyop2.mpi import COMM_WORLD, internal_comm, MPI
+from petsctools import OptionsManager
 from firedrake.cython import hdf5interface as h5i
 from firedrake.cython import dmcommon
-from firedrake.petsc import PETSc, OptionsManager
+from firedrake.petsc import PETSc
 from firedrake.mesh import MeshTopology, ExtrudedMeshTopology, DEFAULT_MESH_NAME, make_mesh_from_coordinates, DistributedMeshOverlapType
 from firedrake.functionspace import FunctionSpace
 from firedrake import functionspaceimpl as impl

firedrake/eigensolver.py

@@ -1,10 +1,10 @@
 """Specify and solve finite element eigenproblems."""
+from petsctools import OptionsManager, flatten_parameters
 from firedrake.assemble import assemble
 from firedrake.bcs import extract_subdomain_ids, restricted_function_space
 from firedrake.function import Function
 from firedrake.ufl_expr import TrialFunction, TestFunction
 from firedrake import utils
-from firedrake.petsc import OptionsManager, flatten_parameters
 from firedrake.exceptions import ConvergenceError
 from ufl import replace, inner, dx
 try:

firedrake/mesh.py

@@ -22,6 +22,7 @@
     MPI, COMM_WORLD, internal_comm, is_pyop2_comm, temp_internal_comm
 )
 from pyop2.utils import as_tuple
+from petsctools import OptionsManager, get_external_packages
 
 import firedrake.cython.dmcommon as dmcommon
 from firedrake.cython.dmcommon import DistributedMeshOverlapType
@@ -32,9 +33,7 @@
 from firedrake.utils import as_cstr, IntType, RealType
 from firedrake.logging import info_red
 from firedrake.parameters import parameters
-from firedrake.petsc import (
-    PETSc, OptionsManager, get_external_packages, DEFAULT_PARTITIONER
-)
+from firedrake.petsc import PETSc, DEFAULT_PARTITIONER
 from firedrake.adjoint_utils import MeshGeometryMixin
 from pyadjoint import stop_annotating
 import gem