passagemath-environment 10.4.1__py3-none-any.whl

sage/features/sat.py

@@ -0,0 +1,103 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Feature for testing the presence of SAT solvers
+"""
+
+from . import Executable, PythonModule
+
+
+class Glucose(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of an
+    executable from the :ref:`Glucose SAT solver <spkg_glucose>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.sat import Glucose
+        sage: GlucoseExecutable().is_present()                  # optional - glucose
+        FeatureTestResult('glucose', True)
+    """
+    def __init__(self, executable="glucose"):
+        r"""
+        TESTS::
+
+            sage: from sage.features.sat import Glucose
+            sage: isinstance(Glucose(), Glucose)
+            True
+        """
+        Executable.__init__(self, name=executable, executable=executable,
+                            spkg="glucose", type="optional")
+
+
+class Kissat(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the
+    :ref:`Kissat SAT solver <spkg_kissat>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.sat import Kissat
+        sage: Kissat().is_present()                             # optional - kissat
+        FeatureTestResult('kissat', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.sat import Kissat
+            sage: isinstance(Kissat(), Kissat)
+            True
+        """
+        Executable.__init__(self, name="kissat", executable="kissat",
+                            spkg="kissat", type="optional")
+
+
+class Pycosat(PythonModule):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of :ref:`spkg_pycosat`.
+
+    EXAMPLES::
+
+        sage: from sage.features.sat import Pycosat
+        sage: PycosatExecutable().is_present()                  # optional - pycosat
+        FeatureTestResult('pycosat', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.sat import Pycosat
+            sage: isinstance(Pycosat(), Pycosat)
+            True
+        """
+        PythonModule.__init__(self, "pycosat",
+                              spkg="pycosat", type="optional")
+
+
+class Pycryptosat(PythonModule):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of :ref:`spkg_pycryptosat`.
+
+    EXAMPLES::
+
+        sage: from sage.features.sat import Pycryptosat
+        sage: PycryptosatExecutable().is_present()              # optional - pycryptosat
+        FeatureTestResult('pycryptosat', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.sat import Pycryptosat
+            sage: isinstance(Pycryptosat(), Pycryptosat)
+            True
+        """
+        PythonModule.__init__(self, "pycryptosat",
+                              spkg="pycryptosat", type="optional")
+
+
+def all_features():
+    return [Glucose(),
+            Kissat(),
+            Pycosat(),
+            Pycryptosat()]

sage/features/singular.py

@@ -0,0 +1,48 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``singular`` and the SageMath interfaces to it
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2022-2023 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 Executable, PythonModule
+from .join_feature import JoinFeature
+from .sagemath import sage__libs__singular
+from sage.env import SINGULAR_BIN
+
+
+class Singular(Executable):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the :ref:`singular <spkg_singular>` executable.
+
+    .. SEEALSO::
+
+        :class:`Feature sage.libs.singular <~sage.features.sagemath.sage__libs__singular>`
+
+    EXAMPLES::
+
+        sage: from sage.features.singular import Singular
+        sage: Singular().is_present()                                                   # needs singular
+        FeatureTestResult('singular', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.singular import Singular
+            sage: isinstance(Singular(), Singular)
+            True
+        """
+        Executable.__init__(self, "singular", SINGULAR_BIN,
+                            spkg='singular', type='standard')
+
+
+def all_features():
+    return [Singular()]

sage/features/sirocco.py

@@ -0,0 +1,45 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``sirocco``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2016      Julian Rüth
+#                     2018      Jeroen Demeyer
+#                     2021-2024 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 Sirocco(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` which describes whether the :mod:`sage.libs.sirocco`
+    module is available in this installation of Sage.
+
+    EXAMPLES::
+
+        sage: from sage.features.sirocco import Sirocco
+        sage: Sirocco().require()  # optional - sirocco
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.sirocco import Sirocco
+            sage: Sirocco()
+            Feature('sirocco')
+        """
+        JoinFeature.__init__(self, "sirocco",
+                             [PythonModule("sage.libs.sirocco",
+                                           spkg='sagemath_sirocco')])
+
+
+def all_features():
+    return [Sirocco()]

sage/features/sphinx.py

@@ -0,0 +1,71 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``sphinx``
+"""
+
+# *****************************************************************************
+#       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
+
+
+class Sphinx(PythonModule):
+    r"""
+    A :class:`sage.features.Feature` describing the presence of :ref:`Sphinx <spkg_sphinx>`.
+
+    Sphinx is provided by a standard package in the Sage distribution,
+    but it can be disabled by ``configure --disable-doc``.
+
+    EXAMPLES::
+
+        sage: from sage.features.sphinx import Sphinx
+        sage: Sphinx().is_present()                     # optional - sphinx
+        FeatureTestResult('sphinx', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.sphinx import Sphinx
+            sage: isinstance(Sphinx(), Sphinx)
+            True
+        """
+        PythonModule.__init__(self, 'sphinx', spkg='sphinx', type='standard')
+
+
+class JupyterSphinx(PythonModule):
+    r"""
+    A :class:`sage.features.Feature` describing the presence of
+    :ref:`jupyter_sphinx <spkg_jupyter_sphinx>`.
+
+    It is provided by a standard package in the Sage distribution,
+    but it can be disabled by ``configure --disable-doc`` and
+    ``configure --disable-notebook``.
+
+    EXAMPLES::
+
+        sage: from sage.features.sphinx import JupyterSphinx
+        sage: JupyterSphinx().is_present()                      # optional - jupyter_sphinx
+        FeatureTestResult('jupyter_sphinx', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.sphinx import JupyterSphinx
+            sage: isinstance(JupyterSphinx(), JupyterSphinx)
+            True
+        """
+        PythonModule.__init__(self, 'jupyter_sphinx',
+                              spkg='jupyter_sphinx', type='standard')
+
+
+def all_features():
+    return [Sphinx(),
+            JupyterSphinx()]

sage/features/standard.py

@@ -0,0 +1,38 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Check for various standard packages (for modularized distributions)
+
+These features are provided by standard packages in the Sage distribution.
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2023 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
+
+
+def all_features():
+    return [PythonModule('cvxopt', spkg='cvxopt', type='standard'),
+            PythonModule('fpylll', spkg='fpylll', type='standard'),
+            JoinFeature('ipython', (PythonModule('IPython'),), spkg='ipython', type='standard'),
+            JoinFeature('lrcalc_python', (PythonModule('lrcalc'),), spkg='lrcalc_python', type='standard'),
+            PythonModule('mpmath', spkg='mpmath', type='standard'),
+            PythonModule('networkx', spkg='networkx', type='standard'),
+            PythonModule('numpy', spkg='numpy', type='standard'),
+            PythonModule('pexpect', spkg='pexpect', type='standard'),
+            JoinFeature('pillow', (PythonModule('PIL'),), spkg='pillow', type='standard'),
+            JoinFeature('pplpy', (PythonModule('ppl'),), spkg='pplpy', type='standard'),
+            PythonModule('primecountpy', spkg='primecountpy', type='standard'),
+            PythonModule('ptyprocess', spkg='ptyprocess', type='standard'),
+            PythonModule('pyparsing', spkg='pyparsing', type='standard'),
+            PythonModule('requests', spkg='requests', type='standard'),
+            PythonModule('rpy2', spkg='rpy2', type='standard'),
+            PythonModule('scipy', spkg='scipy', type='standard'),
+            PythonModule('sympy', spkg='sympy', type='standard')]

sage/features/symengine_py.py

@@ -0,0 +1,44 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Check for symengine_py
+"""
+
+# ****************************************************************************
+#       Copyright (C) 2023 Dima Pasechnik
+#
+# 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 PythonModule
+from .join_feature import JoinFeature
+
+
+class symengine_py(JoinFeature):
+    r"""
+    A :class:`sage.features.Feature` describing the presence of the
+    Python package :ref:`symengine_py <spkg_symengine_py>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.symengine_py import symengine_py
+        sage: symengine_py().is_present()                    # optional - symengine_py
+        FeatureTestResult('symengine_py', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.symengine_py import symengine_py
+            sage: isinstance(symengine_py(), symengine_py)
+            True
+        """
+        JoinFeature.__init__(self, 'symengine_py',
+                             [PythonModule('symengine', spkg='symengine_py',
+                                            url='https://pypi.org/project/symengine')])
+
+def all_features():
+    return [symengine_py()]

sage/features/tdlib.py

@@ -0,0 +1,38 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of ``tdlib``
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2021 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 PythonModule
+from .join_feature import JoinFeature
+
+
+class Tdlib(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the SageMath interface to the :ref:`tdlib <spkg_tdlib>` library.
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.tdlib import Tdlib
+            sage: isinstance(Tdlib(), Tdlib)
+            True
+        """
+        JoinFeature.__init__(self, 'tdlib',
+                             [PythonModule('sage.graphs.graph_decompositions.tdlib',
+                                           spkg='sagemath_tdlib')])
+
+
+def all_features():
+    return [Tdlib()]

sage/features/threejs.py

@@ -0,0 +1,75 @@
+# sage_setup: distribution = sagemath-environment
+from pathlib import Path
+
+from . import StaticFile
+
+
+class Threejs(StaticFile):
+    r"""
+    A :class:`~sage.features.Feature` which describes the presence of
+    threejs-sage in a few standard locations.
+
+    EXAMPLES::
+
+        sage: from sage.features.threejs import Threejs
+        sage: bool(Threejs().is_present())  # needs threejs
+        True
+    """
+
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.threejs import Threejs
+            sage: isinstance(Threejs(), Threejs)
+            True
+        """
+        from sage.env import SAGE_SHARE, THREEJS_DIR
+
+        share_dir = Path(SAGE_SHARE)
+        threejs_search_path = THREEJS_DIR or (
+            (share_dir / "jupyter" / "nbextensions" / "threejs-sage"),
+            (share_dir / "sagemath" / "threejs-sage"),
+            (share_dir / "sage" / "threejs"),
+            (share_dir / "threejs-sage")
+            )
+
+        try:
+            version = self.required_version()
+            filename = Path(version) / "three.min.js"
+        except FileNotFoundError:
+            filename = 'unknown'
+
+        StaticFile.__init__(
+            self, name='threejs',
+            filename=filename,
+            spkg='threejs',
+            type='standard',
+            search_path=threejs_search_path,
+            description="JavaScript library to display 3D graphics")
+
+    def required_version(self):
+        """
+        Return the version of threejs that Sage requires.
+
+        Defining what version is required is delegated to the distribution package
+        that provides the file ``threejs-version.txt`` in :mod:`sage.ext_data.threejs`.
+
+        If the file is not provided, :exc:`FileNotFoundError` is raised.
+
+        EXAMPLES::
+
+            sage: from sage.features.threejs import Threejs
+            sage: Threejs().required_version()
+            'r...'
+        """
+        from sage.env import SAGE_EXTCODE
+
+        filename = Path(SAGE_EXTCODE) / 'threejs' / 'threejs-version.txt'
+
+        with open(filename) as f:
+            return f.read().strip()
+
+
+def all_features():
+    return [Threejs()]

sage/features/topcom.py

@@ -0,0 +1,67 @@
+# sage_setup: distribution = sagemath-environment
+r"""
+Features for testing the presence of topcom executables
+"""
+
+# *****************************************************************************
+#       Copyright (C) 2022-2024 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 Executable
+from .join_feature import JoinFeature
+
+
+class TOPCOMExecutable(Executable):
+    r"""
+    A :class:`~sage.features.Feature` which checks for executables from the :ref:`TOPCOM <spkg_topcom>` package.
+
+    EXAMPLES::
+
+        sage: from sage.features.topcom import TOPCOMExecutable
+        sage: TOPCOMExecutable('points2allfinetriangs').is_present()    # optional - topcom
+        FeatureTestResult('topcom_points2allfinetriangs', True)
+    """
+    def __init__(self, name):
+        r"""
+        TESTS::
+
+            sage: from sage.features.topcom import TOPCOMExecutable
+            sage: isinstance(TOPCOMExecutable('points2finetriangs'), TOPCOMExecutable)
+            True
+        """
+        Executable.__init__(self, name=f"topcom_{name}",
+                            executable=name,
+                            spkg="topcom")
+
+
+class TOPCOM(JoinFeature):
+    r"""
+    A :class:`~sage.features.Feature` describing the presence of the executables
+    which comes as a part of :ref:`TOPCOM <spkg_topcom>`.
+
+    EXAMPLES::
+
+        sage: from sage.features.topcom import TOPCOM
+        sage: TOPCOM().is_present()                             # optional - topcom
+        FeatureTestResult('topcom', True)
+    """
+    def __init__(self):
+        r"""
+        TESTS::
+
+            sage: from sage.features.topcom import TOPCOM
+            sage: isinstance(TOPCOM(), TOPCOM)
+            True
+        """
+        JoinFeature.__init__(self, "topcom",
+                             [TOPCOMExecutable(name)
+                              for name in ('points2allfinetriangs',)])
+
+
+def all_features():
+    return [TOPCOM()]

sage/misc/all__sagemath_environment.py

@@ -0,0 +1,2 @@
+# sage_setup: distribution = sagemath-environment
+from sage.misc.temporary_file import tmp_dir, tmp_filename