Skip to content

Commit e54d23a

Browse files
committed
improvements to backend documentation
1 parent 50b235d commit e54d23a

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

docs/source/reference/backends.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
Backend Interfaces
22
==================
33

4+
See :class:`.ACSVSettings` for information on how to
5+
configure the default computational backends. The module
6+
:mod:`.sage_acsv.groebner` is the entrypoint for Groebner basis
7+
computations.
8+
49
.. toctree::
510
:maxdepth: 2
611

sage_acsv/groebner.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
"""Central interface for accessing and using different backends
22
for Groebner basis computations.
3+
4+
Depending on the chosen backend for Groebner basis computations
5+
(via :meth:`.ACSVSettings.set_default_groebner_backend`, allowed
6+
values are given in :class:`.ACSVSettings.Groebner`) the members
7+
of this module delegate their computations to the available
8+
computational backends:
9+
10+
- :mod:`.backends.default`
11+
- :mod:`.backends.macaulay2`
312
"""
413

514

0 commit comments

Comments
 (0)