misc: Fix typos in Devito

Author: JDBetteridge

FAQ.md

@@ -64,7 +64,7 @@ Focus on modeling and math — Devito handles the performance.
 
 
 ## What Devito is not
-As is hopefully implied by the preceeding section, Devito is *not* a seismic modelling or imaging framework, nor is it a set of pre-baked solvers. Whilst Devito is often associated with seismic imaging, this is just one application domain. Our RTM and FWI examples use Devito under the hood, but the engine itself is physics-agnostic. There’s no built-in assumption about waves, seismics, or domains — you provide the physics, and Devito delivers efficient, architecture-aware implementations.
+As is hopefully implied by the preceding section, Devito is *not* a seismic modelling or imaging framework, nor is it a set of pre-baked solvers. Whilst Devito is often associated with seismic imaging, this is just one application domain. Our RTM and FWI examples use Devito under the hood, but the engine itself is physics-agnostic. There’s no built-in assumption about waves, seismics, or domains — you provide the physics, and Devito delivers efficient, architecture-aware implementations.
 
 Furthermore, the examples provided with Devito are often conflated with the core DSL and compiler. However, the purpose of this collection of tutorials, code samples, and helper functions is fourfold:
 

benchmarks/user/advisor/README.md

@@ -7,7 +7,7 @@ We recommend going through tutorial [02_advisor_roofline.ipynb](https://github.c
 * Support is guaranteed only for Intel oneAPI 2025; earlier versions may not work.
 You may download Intel oneAPI [here](https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit-download.html?packages=oneapi-toolkit&oneapi-toolkit-os=linux&oneapi-lin=apt).
 
-* Add Advisor (advixe-cl) and compilers (icx) in the path. The right env variables should be sourced along the lines of (depending on your isntallation folder):
+* Add Advisor (advixe-cl) and compilers (icx) in the path. The right env variables should be sourced along the lines of (depending on your installation folder):
 ```sh
 source /opt/intel/oneapi/advisor/latest/env/vars.sh
 source /opt/intel/oneapi/compiler/latest/env/vars.sh

conftest.py

@@ -370,15 +370,15 @@ def assert_structure(operator, exp_trees=None, exp_iters=None):
     if exp_trees is not None:
         trees = retrieve_iteration_tree(operator)
         exp_trees = [i.replace(',', '') for i in exp_trees]  # 't,x,y' -> 'txy'
-        tree_struc = (["".join(mapper.get(i.dim.name, i.dim.name) for i in j)
+        tree_struct = (["".join(mapper.get(i.dim.name, i.dim.name) for i in j)
                        for j in trees])  # Flatten every tree's dims as a string
-        assert tree_struc == exp_trees
+        assert tree_struct == exp_trees
 
     if exp_iters is not None:
         iters = FindNodes(Iteration).visit(operator)
         exp_iters = exp_iters.replace(',', '')  # 't,x,y' -> 'txy'
-        iter_struc = "".join(mapper.get(i.dim.name, i.dim.name) for i in iters)
-        assert iter_struc == exp_iters
+        iter_struct = "".join(mapper.get(i.dim.name, i.dim.name) for i in iters)
+        assert iter_struct == exp_iters
 
 
 def assert_blocking(operator, exp_nests):

devito/arch/compiler.py

@@ -1027,14 +1027,14 @@ def __init_finalize__(self, **kwargs):
         self._base.__init_finalize__(self, **kwargs)
         # Update cflags
         try:
-            extrac = environ.get('CFLAGS').split(' ')
-            self.cflags = self.cflags + extrac
+            extra_c = environ.get('CFLAGS').split(' ')
+            self.cflags = self.cflags + extra_c
         except AttributeError:
             pass
         # Update ldflags
         try:
-            extrald = environ.get('LDFLAGS').split(' ')
-            self.ldflags = self.ldflags + extrald
+            extra_ld = environ.get('LDFLAGS').split(' ')
+            self.ldflags = self.ldflags + extra_ld
         except AttributeError:
             pass
 

devito/builtins/initializers.py

@@ -348,6 +348,7 @@ def initialize_function(function, data, nbl, mapper=None, mode='constant',
           [2, 3, 3, 3, 3, 2],
           [2, 2, 2, 2, 2, 2]], dtype=int32)
     """
+    # TODO: fix the horrendous use of pluralisation in this function !!!
     if isinstance(function, (list, tuple)):
         if not isinstance(data, (list, tuple)):
             raise TypeError("Expected a list of `data`")

devito/builtins/utils.py

@@ -109,7 +109,7 @@ def pad_outhalo(function):
             function._data_with_outhalo._local[tuple(slices)] \
                 = function._data_with_outhalo._local[tuple(slices_d)]
         if h.left == 0 and h.right == 0:
-            # Need to access it so that that worker is not blocking exectution since
+            # Need to access it so that that worker is not blocking execution since
             # _data_with_outhalo requires communication
             function._data_with_outhalo._local[0] = function._data_with_outhalo._local[0]
 

devito/checkpointing/checkpoint.py

@@ -51,7 +51,7 @@ class DevitoCheckpoint(Checkpoint):
        pyRevolve. Holds a list of symbol objects that hold data.
     """
     def __init__(self, objects):
-        """Intialise a checkpoint object. Upon initialisation, a checkpoint
+        """Initialise a checkpoint object. Upon initialisation, a checkpoint
         stores only a reference to the objects that are passed into it."""
         assert(all(isinstance(o, TimeFunction) for o in objects))
         dtypes = set([o.dtype for o in objects])
@@ -92,7 +92,7 @@ def get_symbol_data(symbol, timestep):
         # Use `._data`, instead of `.data`, as `.data` is a view of the DOMAIN
         # data region which is non-contiguous in memory. The performance hit from
         # dealing with non-contiguous memory is so big (introduces >1 copy), it's
-        # better to checkpoint unneccesarry stuff to get a contiguous chunk of memory.
+        # better to checkpoint unnecessary stuff to get a contiguous chunk of memory.
         ptr = symbol._data[timestep - i, :, :]
         ptrs.append(ptr)
     return ptrs

devito/core/autotuning.py

@@ -141,7 +141,7 @@ def autotune(operator, args, level, mode):
             update_time_bounds(stepper, at_args, timesteps, mode)
             timer.reset()
 
-    # The best variant is the one that for a given number of threads had the minium
+    # The best variant is the one that for a given number of threads had the minimum
     # turnaround time
     try:
         runs = 0

devito/core/operator.py

@@ -73,7 +73,7 @@ class BasicOperator(Operator):
     CIRE_MINMEM = True
     """
     Minimize memory consumption when allocating temporaries for CIRE-optimized
-    expressions. This may come at the cost of slighly worse performance due to
+    expressions. This may come at the cost of slightly worse performance due to
     the potential need for extra registers to hold a greater number of support
     variables (e.g., strides).
     """
@@ -91,7 +91,7 @@ class BasicOperator(Operator):
 
     PAR_COLLAPSE_WORK = 100
     """
-    Use a collapse clause if the trip count of the collapsable loops is statically
+    Use a collapse clause if the trip count of the collapsible loops is statically
     known to exceed this threshold.
     """
 
@@ -172,7 +172,7 @@ class BasicOperator(Operator):
 
     @classmethod
     def _normalize_kwargs(cls, **kwargs):
-        # Will be populated with dummy values; this method is actually overriden
+        # Will be populated with dummy values; this method is actually overridden
         # by the subclasses
         o = {}
         oo = kwargs['options']

devito/data/data.py

@@ -337,7 +337,7 @@ def __setitem__(self, glb_idx, val, comm_type):
         elif np.isscalar(val):
             if index_is_basic(loc_idx):
                 # Won't go through `__getitem__` as it's basic indexing mode,
-                # so we should just propage `loc_idx`
+                # so we should just propagate `loc_idx`
                 super().__setitem__(loc_idx, val)
             else:
                 super().__setitem__(glb_idx, val)