From fb32f55b4f88bc08c98f02278cf40d1927da0073 Mon Sep 17 00:00:00 2001 From: Matt Wala <wala1@illinois.edu> Date: Tue, 7 Nov 2017 19:57:06 -0600 Subject: [PATCH] Document environment variables --- doc/misc.rst | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/doc/misc.rst b/doc/misc.rst index c77c7c22..113427ed 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 -- GitLab