passagemath-environment 10.4.1__py3-none-any.whl

sage/features/mip_backends.py

@@ -0,0 +1,114 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of :class:`MixedIntegerLinearProgram` backends
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2021-2022 Matthias Koeppe
+#                     2021      Kwankyu Lee
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+from . import Feature, PythonModule, FeatureTestResult
+from .join_feature import JoinFeature
+
+
+class MIPBackend(Feature):
+    r"""
+    A :class:`~sage.features.Feature` describing whether a :class:`MixedIntegerLinearProgram` backend is available.
+    """
+    def _is_present(self):
+        r"""
+        Test for the presence of a :class:`MixedIntegerLinearProgram` backend.
+
+        EXAMPLES::
+
+            sage: from sage.features.mip_backends import CPLEX
+            sage: CPLEX()._is_present()  # optional - cplex
+            FeatureTestResult('cplex', True)
+        """
+        try:
+            from sage.numerical.mip import MixedIntegerLinearProgram
+            MixedIntegerLinearProgram(solver=self.name)
+            return FeatureTestResult(self, True)
+        except Exception:
+            return FeatureTestResult(self, False)
+
+
+class CPLEX(MIPBackend):
+    r"""
+    A :class:`~sage.features.Feature` describing whether the :class:`MixedIntegerLinearProgram` backend ``CPLEX`` is available.
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.mip_backends import CPLEX
+            sage: CPLEX()._is_present()  # optional - cplex
+            FeatureTestResult('cplex', True)
+        """
+        MIPBackend.__init__(self, 'cplex',
+                            spkg='sage_numerical_backends_cplex')
+
+
+class Gurobi(MIPBackend):
+    r"""
+    A :class:`~sage.features.Feature` describing whether the :class:`MixedIntegerLinearProgram` backend ``Gurobi`` is available.
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.mip_backends import Gurobi
+            sage: Gurobi()._is_present()  # optional - gurobi
+            FeatureTestResult('gurobi', True)
+        """
+        MIPBackend.__init__(self, 'gurobi',
+                            spkg='sage_numerical_backends_gurobi')
+
+
+class COIN(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing whether the :class:`MixedIntegerLinearProgram` backend ``COIN`` is available.
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.mip_backends import COIN
+            sage: COIN()._is_present()  # optional - sage_numerical_backends_coin
+            FeatureTestResult('sage_numerical_backends_coin', True)
+        """
+        JoinFeature.__init__(self, 'sage_numerical_backends_coin',
+                             [MIPBackend('coin')],
+                             spkg='sage_numerical_backends_coin')
+
+
+class CVXOPT(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing whether the :class:`MixedIntegerLinearProgram` backend ``CVXOPT`` is available.
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.mip_backends import CVXOPT
+            sage: CVXOPT()._is_present()  # optional - cvxopt
+            FeatureTestResult('cvxopt', True)
+        """
+        JoinFeature.__init__(self, 'cvxopt',
+                             [MIPBackend('CVXOPT'),
+                              PythonModule('cvxopt')],
+                             spkg='cvxopt',
+                             type='standard')
+
+
+def all_features():
+    return [CPLEX(),
+            Gurobi(),
+            COIN(),
+            CVXOPT()]

sage/features/msolve.py

@@ -0,0 +1,68 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of msolve
+
+`msolve <https://msolve.lip6.fr/>`_ is a multivariate polynomial system solver.
+
+.. SEEALSO::
+
+    - :mod:`sage.rings.polynomial.msolve`
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2022 Marc Mezzarobba
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+import subprocess
+from . import Executable
+from . import FeatureTestResult
+
+class msolve(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of :ref:`msolve <spkg_msolve>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.msolve import msolve
+        sage: msolve().is_present()  # optional - msolve
+        FeatureTestResult('msolve', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.msolve import msolve
+            sage: isinstance(msolve(), msolve)
+            True
+        """
+        Executable.__init__(self, "msolve", executable='msolve',
+                            url='https://msolve.lip6.fr/')
+
+    def is_functional(self):
+        r"""
+        Test if our installation of msolve is working.
+
+        TESTS::
+
+            sage: from sage.features.msolve import msolve
+            sage: msolve().is_functional()  # optional - msolve
+            FeatureTestResult('msolve', True)
+        """
+        msolve_out = subprocess.run(["msolve", "-h"], capture_output=True)
+
+#        if msolve_out.returncode != 0:
+#            return FeatureTestResult(self, False, reason="msolve -h returned "
+#                                f"nonzero exit status {msolve_out.returncode}")
+        if (msolve_out.stdout[:46] !=
+              b'\nmsolve library for polynomial system solving\n'):
+            return FeatureTestResult(self, False,
+                                     reason="output of msolve -h not recognized")
+        return FeatureTestResult(self, True)
+
+def all_features():
+    return [msolve()]

sage/features/nauty.py

@@ -0,0 +1,70 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of nauty executables
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2022 Matthias Koeppe
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+from sage.env import SAGE_NAUTY_BINS_PREFIX
+
+from . import Executable
+from .join_feature import JoinFeature
+
+
+class NautyExecutable(Executable):
+    r"""
+    A :class:`~sage.features.Feature` which checks for executables from the :ref:`nauty <spkg_nauty>` package.
+
+    EXAMPLES::
+
+        sage: from sage.features.nauty import NautyExecutable
+        sage: NautyExecutable('converseg').is_present()                                 # needs nauty
+        FeatureTestResult('nauty_converseg', True)
+    """
+    def __init__(self, name):
+        r"""
+        TESTS::
+
+            sage: from sage.features.nauty import NautyExecutable
+            sage: isinstance(NautyExecutable('geng'), NautyExecutable)
+            True
+        """
+        Executable.__init__(self, name=f"nauty_{name}",
+                            executable=f"{SAGE_NAUTY_BINS_PREFIX}{name}",
+                            spkg='nauty',
+                            type='standard')
+
+
+class Nauty(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the executables
+    which comes as a part of :ref:`nauty <spkg_nauty>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.nauty import Nauty
+        sage: Nauty().is_present()                                                      # needs nauty
+        FeatureTestResult('nauty', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.nauty import Nauty
+            sage: isinstance(Nauty(), Nauty)
+            True
+        """
+        JoinFeature.__init__(self, "nauty",
+                             [NautyExecutable(name)
+                              for name in ('directg', 'gentourng', 'geng', 'genbg', 'gentreeg', 'genktreeg')])
+
+
+def all_features():
+    return [Nauty()]

sage/features/normaliz.py

@@ -0,0 +1,43 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``pynormaliz``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2021 Matthias Koeppe
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+from . import PythonModule
+from .join_feature import JoinFeature
+
+
+class PyNormaliz(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the
+    Python package :ref:`PyNormaliz <spkg_pynormaliz>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.normaliz import PyNormaliz
+        sage: PyNormaliz().is_present()                    # optional - pynormaliz
+        FeatureTestResult('pynormaliz', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.normaliz import PyNormaliz
+            sage: isinstance(PyNormaliz(), PyNormaliz)
+            True
+        """
+        JoinFeature.__init__(self, 'pynormaliz',
+                             [PythonModule('PyNormaliz', spkg='pynormaliz')])
+
+
+def all_features():
+    return [PyNormaliz()]

sage/features/palp.py

@@ -0,0 +1,65 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``palp``
+"""
+# ****************************************************************************
+#       Copyright (C) 2022 Matthias Koeppe
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# ****************************************************************************
+
+from . import Executable
+from .join_feature import JoinFeature
+
+
+class PalpExecutable(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of a :ref:`PALP <spkg_palp>` executable.
+
+    INPUT:
+
+    - ``palpprog`` -- string, one of ``'poly'``, ``'class'``, ``'nef'``, ``'cws'``
+
+    - ``suff`` -- string or ``None``
+    """
+    def __init__(self, palpprog, suff=None):
+        r"""
+        TESTS::
+
+            sage: from sage.features.palp import PalpExecutable
+            sage: isinstance(PalpExecutable("poly", 5), PalpExecutable)
+            True
+        """
+        if suff:
+            Executable.__init__(self, f"palp_{palpprog}_{suff}d",
+                                executable=f"{palpprog}-{suff}d.x",
+                                spkg='palp', type='standard')
+        else:
+            Executable.__init__(self, f"palp_{palpprog}",
+                                executable=f"{palpprog}.x",
+                                spkg='palp', type='standard')
+
+class Palp(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of :ref:`PALP <spkg_palp>`.
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.palp import Palp
+            sage: isinstance(Palp(), Palp)
+            True
+        """
+        JoinFeature.__init__(self, "palp",
+                             [PalpExecutable(palpprog, suff)
+                              for palpprog in ("poly", "class", "nef", "cws")
+                              for suff in (None, 4, 5, 6, 11)],
+                             description='PALP')
+
+def all_features():
+    return [Palp()]

sage/features/pandoc.py

@@ -0,0 +1,42 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``pandoc``
+"""
+# ****************************************************************************
+#       Copyright (C) 2018 Thierry Monteil <sage!lma.metelu.net>
+#                     2021 Matthias Koeppe
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# ****************************************************************************
+
+from . import Executable
+
+
+class Pandoc(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of :ref:`pandoc <spkg_pandoc>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.pandoc import Pandoc
+        sage: Pandoc().is_present()  # optional - pandoc
+        FeatureTestResult('pandoc', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.pandoc import Pandoc
+            sage: isinstance(Pandoc(), Pandoc)
+            True
+        """
+        Executable.__init__(self, "pandoc", executable='pandoc',
+                            url='https://pandoc.org/')
+
+
+def all_features():
+    return [Pandoc()]

sage/features/pdf2svg.py

@@ -0,0 +1,41 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of ``pdf2svg``
+"""
+# ****************************************************************************
+#       Copyright (C) 2021 Sebastien Labbe <slabqc@gmail.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# ****************************************************************************
+
+from . import Executable
+
+class pdf2svg(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of :ref:`pdf2svg <spkg_pdf2svg>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.pdf2svg import pdf2svg
+        sage: pdf2svg().is_present()             # optional - pdf2svg
+        FeatureTestResult('pdf2svg', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.pdf2svg import pdf2svg
+            sage: isinstance(pdf2svg(), pdf2svg)
+            True
+        """
+        Executable.__init__(self, "pdf2svg", executable='pdf2svg',
+                            spkg='pdf2svg',
+                            url='http://www.cityinthesky.co.uk/opensource/pdf2svg/')
+
+
+def all_features():
+    return [pdf2svg()]

sage/features/phitigra.py

@@ -0,0 +1,42 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Check for ``phitigra``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2022 Jean-Florent Raymond
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+from . import PythonModule
+
+
+class Phitigra(PythonModule):
+    r"""
+    A :class:`sage.features.Feature` describing the presence of :ref:`phitigra <spkg_phitigra>`.
+
+    Phitigra is provided by an optional package in the Sage distribution.
+
+    EXAMPLES::
+
+        sage: from sage.features.phitigra import Phitigra
+        sage: Phitigra().is_present()                     # optional - phitigra
+        FeatureTestResult('phitigra', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.phitigra import Phitigra
+            sage: isinstance(Phitigra(), Phitigra)
+            True
+        """
+        PythonModule.__init__(self, 'phitigra', spkg='phitigra')
+
+
+def all_features():
+    return [Phitigra()]

sage/features/pkg_systems.py

@@ -0,0 +1,195 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of package systems ``sage_spkg``, ``conda``, ``pip``, ``debian``, ``fedora`` etc.
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2021-2022 Matthias Koeppe
+#
+#  Distributed under the terms of the GNU General Public License (GPL)
+#  as published by the Free Software Foundation; either version 2 of
+#  the License, or (at your option) any later version.
+#                  https://www.gnu.org/licenses/
+# *****************************************************************************
+
+from . import Feature
+
+
+class PackageSystem(Feature):
+    r"""
+    A :class:`Feature` describing a system package manager.
+
+    EXAMPLES::
+
+        sage: from sage.features.pkg_systems import PackageSystem
+        sage: PackageSystem('conda')
+        Feature('conda')
+    """
+    def _is_present(self):
+        r"""
+        Test whether ``self`` appears in the list of available package systems.
+
+        EXAMPLES::
+
+            sage: from sage.features.pkg_systems import PackageSystem
+            sage: debian = PackageSystem('debian')
+            sage: debian.is_present()  # indirect doctest, random
+            True
+        """
+        from . import package_systems
+        return self in package_systems()
+
+    def spkg_installation_hint(self, spkgs, *, prompt="  !", feature=None):
+        r"""
+        Return a string that explains how to install ``feature``.
+
+        EXAMPLES::
+
+            sage: from sage.features.pkg_systems import PackageSystem
+            sage: homebrew = PackageSystem('homebrew')
+            sage: homebrew.spkg_installation_hint('openblas')  # optional - SAGE_ROOT
+            'To install openblas using the homebrew package manager, you can try to run:\n!brew install openblas'
+        """
+        if isinstance(spkgs, (tuple, list)):
+            spkgs = ' '.join(spkgs)
+        if feature is None:
+            feature = spkgs
+        return self._spkg_installation_hint(spkgs, prompt, feature)
+
+    def _spkg_installation_hint(self, spkgs, prompt, feature):
+        r"""
+        Return a string that explains how to install ``feature``.
+
+        Override this method in derived classes.
+
+        EXAMPLES::
+
+            sage: from sage.features.pkg_systems import PackageSystem
+            sage: fedora = PackageSystem('fedora')
+            sage: fedora.spkg_installation_hint('openblas')  # optional - SAGE_ROOT
+            'To install openblas using the fedora package manager, you can try to run:\n!sudo yum install openblas-devel'
+        """
+        from subprocess import run, CalledProcessError, PIPE
+        lines = []
+        system = self.name
+        try:
+            proc = run(f'sage-get-system-packages {system} {spkgs}',
+                       shell=True, capture_output=True, text=True, check=True)
+            system_packages = proc.stdout.strip()
+            print_sys = f'sage-print-system-package-command {system} --verbose --sudo --prompt="{prompt}"'
+            command = f'{print_sys} update && {print_sys} install {system_packages}'
+            proc = run(command, shell=True, capture_output=True, text=True, check=True)
+            command = proc.stdout.strip()
+            if command:
+                lines.append(f'To install {feature} using the {system} package manager, you can try to run:')
+                lines.append(command)
+                return '\n'.join(lines)
+        except CalledProcessError:
+            pass
+        return f'No equivalent system packages for {system} are known to Sage.'
+
+
+class SagePackageSystem(PackageSystem):
+    r"""
+    A :class:`Feature` describing the package manager of the SageMath distribution.
+
+    EXAMPLES::
+
+        sage: from sage.features.pkg_systems import SagePackageSystem
+        sage: SagePackageSystem()
+        Feature('sage_spkg')
+    """
+    @staticmethod
+    def __classcall__(cls):
+        r"""
+        Normalize initargs.
+
+        TESTS::
+
+            sage: from sage.features.pkg_systems import SagePackageSystem
+            sage: SagePackageSystem() is SagePackageSystem()  # indirect doctest
+            True
+        """
+        return PackageSystem.__classcall__(cls, "sage_spkg")
+
+    def _is_present(self):
+        r"""
+        Test whether ``sage-spkg`` is available.
+
+        EXAMPLES::
+
+            sage: from sage.features.pkg_systems import SagePackageSystem
+            sage: bool(SagePackageSystem().is_present())  # indirect doctest, optional - sage_spkg
+            True
+        """
+        from subprocess import run, DEVNULL, CalledProcessError
+        try:
+            # "sage -p" is a fast way of checking whether sage-spkg is available.
+            run('sage -p', shell=True, stdout=DEVNULL, stderr=DEVNULL, check=True)
+        except CalledProcessError:
+            return False
+        # Check if there are any installation records.
+        try:
+            from sage.misc.package import installed_packages
+        except ImportError:
+            return False
+        for pkg in installed_packages(exclude_pip=True):
+            return True
+        return False
+
+    def _spkg_installation_hint(self, spkgs, prompt, feature):
+        r"""
+        Return a string that explains how to install ``feature``.
+
+        EXAMPLES::
+
+            sage: from sage.features.pkg_systems import SagePackageSystem
+            sage: print(SagePackageSystem().spkg_installation_hint(['foo', 'bar'], prompt="### ", feature='foobarability'))  # indirect doctest
+            To install foobarability using the Sage package manager, you can try to run:
+            ### sage -i foo bar
+        """
+        lines = []
+        lines.append(f'To install {feature} using the Sage package manager, you can try to run:')
+        lines.append(f'{prompt}sage -i {spkgs}')
+        return '\n'.join(lines)
+
+
+class PipPackageSystem(PackageSystem):
+    r"""
+    A :class:`Feature` describing the Pip package manager.
+
+    EXAMPLES::
+
+        sage: from sage.features.pkg_systems import PipPackageSystem
+        sage: PipPackageSystem()
+        Feature('pip')
+    """
+    @staticmethod
+    def __classcall__(cls):
+        r"""
+        Normalize initargs.
+
+        TESTS::
+
+            sage: from sage.features.pkg_systems import PipPackageSystem
+            sage: PipPackageSystem() is PipPackageSystem()  # indirect doctest
+            True
+        """
+        return PackageSystem.__classcall__(cls, "pip")
+
+    def _is_present(self):
+        r"""
+        Test whether ``pip`` is available.
+
+        EXAMPLES::
+
+            sage: from sage.features.pkg_systems import PipPackageSystem
+            sage: bool(PipPackageSystem().is_present())    # indirect doctest
+            True
+        """
+        from subprocess import run, DEVNULL, CalledProcessError
+        try:
+            run('sage -pip --version', shell=True, stdout=DEVNULL, stderr=DEVNULL, check=True)
+            return True
+        except CalledProcessError:
+            return False