diff --git a/doc/misc.rst b/doc/misc.rst index c77c7c2252b5d92978c1f8ab33d28a7cabea4913..113427ede53e0c739dcd764b617b2c7bad0d1717 100644 --- a/doc/misc.rst +++ b/doc/misc.rst @@ -19,8 +19,25 @@ and say:: In addition, you need to have :mod:`numpy` installed. +Usage +===== + +Environment variables +--------------------- + ++-----------------------------------+-----------------------------------------------------+ +| Name | Purpose | ++===================================+=====================================================+ +| `SUMPY_FORCE_SYMBOLIC_BACKEND` | Symbolic backend control, see `Symbolic backends`_ | ++-----------------------------------+-----------------------------------------------------+ +| `SUMPY_NO_CACHE` | If set, disables the on-disk cache | ++-----------------------------------+-----------------------------------------------------+ +| `SUMPY_NO_OPT` | If set, disables performance-oriented :mod:`loopy` | +| | transformations | ++-----------------------------------+-----------------------------------------------------+ + Symbolic backends -================= +----------------- :mod:`sumpy` supports two symbolic backends: sympy and SymEngine. To use the SymEngine backend, ensure that the `SymEngine library