From 623e1fd16fb8310d15dd7668d537eab901402f0a Mon Sep 17 00:00:00 2001 From: Matt Wala Date: Thu, 2 Feb 2017 14:23:23 -0600 Subject: [PATCH] Document symbolic backends. --- doc/misc.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/misc.rst b/doc/misc.rst index c6ea75c3..c77c7c22 100644 --- a/doc/misc.rst +++ b/doc/misc.rst @@ -19,6 +19,19 @@ and say:: In addition, you need to have :mod:`numpy` installed. +Symbolic backends +================= + +:mod:`sumpy` supports two symbolic backends: sympy and SymEngine. To use the +SymEngine backend, ensure that the `SymEngine library +`_ and the `SymEngine Python bindings +`_ are installed. + +By default, :mod:`sumpy` prefers using SymEngine but falls back to sympy if it +detects that SymEngine is not installed. To force the use of a particular +backend, set the environment variable `SUMPY_FORCE_SYMBOLIC_BACKEND` to +`symengine` or `sympy`. + User-visible Changes ==================== -- GitLab