passagemath-doc-pdf 10.8.1a4__tar.gz → 10.8.1rc0__tar.gz

passagemath_doc_pdf-10.8.1rc0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: passagemath-doc-pdf
+Version: 10.8.1rc0
+Summary: passagemath: Documentation in PDF format
+Author-Email: The Sage Developers <sage-support@googlegroups.com>
+Maintainer: Matthias Köppe, passagemath contributors
+License-Expression: GPL-2.0-or-later AND CC-BY-SA-3.0
+Classifier: Development Status :: 6 - Mature
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Project-URL: release notes, https://github.com/passagemath/passagemath/releases
+Project-URL: repo (upstream), https://github.com/sagemath/sage
+Project-URL: repo, https://github.com/passagemath/passagemath
+Project-URL: documentation, https://passagemath.org/docs/latest
+Project-URL: homepage (upstream), https://www.sagemath.org
+Project-URL: discourse, https://passagemath.discourse.group
+Project-URL: tracker (upstream), https://github.com/sagemath/sage/issues
+Project-URL: tracker, https://github.com/passagemath/passagemath/issues
+Description-Content-Type: text/x-rst
+
+=====================================================================
+ passagemath: Documentation in PDF format
+=====================================================================
+
+`passagemath <https://github.com/passagemath/passagemath>`__ is open
+source mathematical software in Python, released under the GNU General
+Public Licence GPLv2+.
+
+It is a fork of `SageMath <https://www.sagemath.org/>`__, which has been
+developed 2005-2025 under the motto “Creating a Viable Open Source
+Alternative to Magma, Maple, Mathematica, and MATLAB”.
+
+The passagemath fork uses the motto "Creating a Free Passage Between the
+Scientific Python Ecosystem and Mathematical Software Communities."
+It was created in October 2024 with the following goals:
+
+-  providing modularized installation with pip,
+-  establishing first-class membership in the scientific Python
+   ecosystem,
+-  giving `clear attribution of upstream
+   projects <https://groups.google.com/g/sage-devel/c/6HO1HEtL1Fs/m/G002rPGpAAAJ>`__,
+-  providing independently usable Python interfaces to upstream
+   libraries,
+-  offering `platform portability and integration testing
+   services <https://github.com/passagemath/passagemath/issues/704>`__
+   to upstream projects,
+-  inviting collaborations with upstream projects,
+-  `building a professional, respectful, inclusive
+   community <https://groups.google.com/g/sage-devel/c/xBzaINHWwUQ>`__,
+-  `empowering Sage users to participate in the scientific Python ecosystem
+   <https://github.com/passagemath/passagemath/issues/248>`__ by publishing packages,
+-  developing a port to `Pyodide <https://pyodide.org/en/stable/>`__ for
+   serverless deployment with Javascript,
+-  developing a native Windows port.
+
+`Full documentation <https://passagemath.org/docs/latest/html/en/index.html>`__ is
+available online.
+
+passagemath attempts to support and provides binary wheels suitable for
+all major Linux distributions and recent versions of macOS.
+
+Binary wheels for native Windows (x86_64) are are available for a subset of
+the passagemath distributions. Use of the full functionality of passagemath
+on Windows currently requires the use of Windows Subsystem for Linux (WSL)
+or virtualization.
+
+The supported Python versions in the passagemath 10.6.x series are 3.10.x-3.14.x.
+
+
+About this pip-installable distribution package
+-----------------------------------------------
+
+When installed from source, the distribution `sagemath-doc-pdf` uses Sphinx
+and LuaLaTeX to build the SageMath documentation in PDF format.

passagemath_doc_pdf-10.8.1rc0/VERSION.txt

@@ -0,0 +1 @@
+10.8.1.rc0

passagemath_doc_pdf-10.8.1rc0/doc/en/reference/spkg/sage_bootstrap.rst

@@ -0,0 +1,98 @@
+.. _spkg_sage_bootstrap:
+
+sage_bootstrap: System package database with support for PURLs (package URLs)
+==================================================================================================
+
+
+This distribution package ``passagemath-bootstrap`` provides:
+
+- a script ``sage-guess-package-system``::
+
+    $ sage-guess-package-system
+    homebrew
+
+- a script ``sage-get-system-packages`` to map PURLs to names of system packages::
+
+    $ sage-get-system-packages gentoo generic/gmp generic/gap
+    sci-mathematics/gap
+    dev-libs/gmp
+
+- a script ``sage-print-system-package-command`` to print system package installation
+  commands for given PURLs::
+
+    $ sage-print-system-package-command void --spkg install generic/gmp generic/gap
+    xbps-install gmp-devel gmpxx-devel
+
+    $ sage-print-system-package-command fedora --spkg --sudo install generic/linbox
+    sudo dnf install linbox linbox-devel
+
+- a script ``sage-package`` to query the system package database::
+
+    $ sage-package properties generic/gmp
+    path:                        .../site-packages/sage_root/build/pkgs/gmp
+    version_with_patchlevel:     6.3.0
+    type:                        standard
+    source:                      normal
+    trees:                       SAGE_LOCAL
+    purl:                        pkg:generic/gmp
+    description:                 Library for arbitrary precision arithmetic
+    uses_python_package_check:   False
+
+- a script ``sage-spkg-info`` to print system package information::
+
+    $ sage-spkg-info generic/macaulay2
+    ...
+
+    $ sage-spkg-info pypi/setuptools
+    ...
+
+- a Python API defined in ``sage_bootstrap``
+
+The database of packages is included with ``passagemath-bootstrap`` and consists of
+over 600 packages; see https://passagemath.org/docs/latest/html/en/reference/spkg/index.html
+for a list of the available packages.
+
+
+Type
+----
+
+optional
+
+
+Dependencies
+------------
+
+- $(PYTHON)
+- $(PYTHON_TOOLCHAIN)
+- :ref:`spkg_setuptools`
+
+Version Information
+-------------------
+
+package-version.txt::
+
+    10.8.1.rc0
+
+version_requirements.txt::
+
+    passagemath-bootstrap == 10.8.1rc0
+
+Installation commands
+---------------------
+
+.. tab:: PyPI:
+
+   .. CODE-BLOCK:: bash
+
+       $ pip install passagemath-bootstrap==10.8.1rc0
+
+.. tab:: Sage distribution:
+
+   .. CODE-BLOCK:: bash
+
+       $ sage -i sage_bootstrap
+
+
+However, these system packages will not be used for building Sage
+because ``spkg-configure.m4`` has not been written for this package;
+see :issue:`27330` for more information.

passagemath_doc_pdf-10.8.1rc0/doc/en/reference/spkg/sage_conf.rst

@@ -0,0 +1,158 @@
+.. _spkg_sage_conf:
+
+sage_conf: Configuration module for the Sage library
+==================================================================================
+
+
+This distribution package ``passagemath-conf`` provides:
+
+- a single Python module, ``sage.config``, providing configuration information
+  to the Sage library at the time of its installation and at its runtime
+
+- a console script ``sage-config``, for querying the variables of ``sage.config``
+  from the shell
+
+- a sourcable shell script ``sage-env-config``, providing additional configuration
+  information in the form of environment variables
+
+The modularized distribution packages of the Sage library
+may declare ``passagemath-conf`` both as a PEP 518 build-system requirement and a run-time
+dependency ("install-requires").
+
+The ``passagemath-conf`` distribution package is polymorphic:  It has several implementations.
+
+
+passagemath-conf sdist on PyPI
+------------------------------
+
+This implementation of the package comes from the directory
+`pkgs/sage-conf_pypi <https://github.com/passagemath/passagemath/tree/main/pkgs/sage-conf_pypi/>`_.
+
+To install, use ``pip install -v passagemath-conf``.  Using ``-v`` ensures that diagnostic
+messages are displayed.
+
+On installation (or building a wheel), it invokes ``sage_bootstrap`` to establish
+a build tree (``SAGE_ROOT``) and installation tree (``SAGE_LOCAL``) for
+the SageMath distribution.  By default, it uses a subdirectory of ``$HOME/.sage``
+that is specific to the version of the distribution and the version of Python in
+use.  If several virtual environments over the same version of Python install
+``passagemath-conf``, they will share these trees.
+
+After installation of ``passagemath-conf``, a wheelhouse containing wheels of
+various libraries is available; type ``ls $(sage-config
+SAGE_SPKG_WHEELS)`` to list them and ``pip install $(sage-config
+SAGE_SPKG_WHEELS)/*.whl`` to install them.  After this, you can install the Sage
+library, for example, using ``pip install sagemath-standard``.
+
+Customization with environment variables:
+
+- ``SAGE_CONF_FILE``, ``SAGE_CONF_ENV_FILE``
+
+  To skip creation of a build tree and bring your own configuration instead,
+  use the environment variables ``SAGE_CONF_FILE`` or ``SAGE_CONF_ENV_FILE``
+  at the build time of the package. The files named by these variables
+  are copied as ``_sage_conf.py`` and ``sage-env-config``.
+
+  For example, to skip creation of a build tree and set no configuration
+  variables at all, you can use::
+
+    export SAGE_CONF_FILE=/dev/null
+
+- ``SAGE_CONF_CONFIGURE_ARGS``
+
+  If set, this is appended to the invocation of ``./configure``.
+
+- ``SAGE_CONF_TARGETS``
+
+  The Makefile targets to build. The default is ``build`` (which builds all
+  standard non-Python and Python packages that have not been disabled).
+  To disable building the wheelhouse, you can use::
+
+    export SAGE_CONF_TARGETS=build-local
+
+
+passagemath-conf in the traditional installation as Sage-the-distribution
+-------------------------------------------------------------------------
+
+The original version of the distribution package ``passagemath-conf`` is used
+internally in Sage-the-distribution.  It is provided in the directory
+`pkgs/sage-conf <https://github.com/passagemath/passagemath/tree/main/pkgs/sage-conf/>`_.
+This version of the package is generated by the Sage distribution's ``./configure``
+script.
+
+
+passagemath-conf for conda
+--------------------------
+
+The version of the distribution package in the directory
+`pkgs/sage-conf_conda <https://github.com/passagemath/passagemath/tree/main/pkgs/sage-conf_conda/>`_
+may be used in an installation method of SageMath, where all packages
+are provided by conda.  This method is described in
+https://passagemath.org/docs/latest/html/en/installation/conda.html#using-conda-to-provide-all-dependencies-for-the-sage-library-experimental
+
+
+passagemath-conf in downstream distributions
+--------------------------------------------
+
+If the customization through the environment variables ``SAGE_CONF_...``
+does not give enough flexibility, downstream packagers and advanced developers
+and users can provide their own implementation of the distribution package
+to support the intended deployment of the Sage library.
+
+
+License
+-------
+
+GNU General Public License (GPL) v3 or later
+
+Upstream Contact
+----------------
+
+This package is included in the main repository of passagemath
+in `pkgs/sage-conf* <https://github.com/passagemath/passagemath/tree/main/pkgs/>`_.
+
+
+Type
+----
+
+standard
+
+
+Dependencies
+------------
+
+- $(PYTHON)
+- $(PYTHON_TOOLCHAIN)
+- :ref:`spkg_python_build`
+- :ref:`spkg_setuptools`
+
+Version Information
+-------------------
+
+package-version.txt::
+
+    10.8.1.rc0
+
+version_requirements.txt::
+
+    passagemath-conf == 10.8.1rc0 ; sys_platform != 'win32'
+
+Installation commands
+---------------------
+
+.. tab:: PyPI:
+
+   .. CODE-BLOCK:: bash
+
+       $ pip install passagemath-conf==10.8.1rc0\;sys_platform\!=\'win32\'
+
+.. tab:: Sage distribution:
+
+   .. CODE-BLOCK:: bash
+
+       $ sage -i sage_conf
+
+
+However, these system packages will not be used for building Sage
+because ``spkg-configure.m4`` has not been written for this package;
+see :issue:`27330` for more information.

passagemath_doc_pdf-10.8.1rc0/doc/en/reference/spkg/sage_docbuild.rst

@@ -0,0 +1,57 @@
+.. _spkg_sage_docbuild:
+
+========================================================================================================
+sage_docbuild: Build system of the Sage documentation
+========================================================================================================
+
+
+This is the build system of the Sage documentation, based on Sphinx.
+
+
+Type
+----
+
+standard
+
+
+Dependencies
+------------
+
+- $(PYTHON)
+- $(PYTHON_TOOLCHAIN)
+- :ref:`spkg_sagelib`
+- :ref:`spkg_setuptools`
+- :ref:`spkg_sphinx`
+
+Version Information
+-------------------
+
+package-version.txt::
+
+    10.8.1.rc0
+
+version_requirements.txt::
+
+    passagemath-docbuild == 10.8.1rc0
+
+See https://repology.org/project/sage-docbuild/versions, https://repology.org/project/python:sage-docbuild/versions
+
+Installation commands
+---------------------
+
+.. tab:: PyPI:
+
+   .. CODE-BLOCK:: bash
+
+       $ pip install passagemath-docbuild==10.8.1rc0
+
+.. tab:: Sage distribution:
+
+   .. CODE-BLOCK:: bash
+
+       $ sage -i sage_docbuild
+
+
+However, these system packages will not be used for building Sage
+because ``spkg-configure.m4`` has not been written for this package;
+see :issue:`27330` for more information.

passagemath_doc_pdf-10.8.1rc0/doc/en/reference/spkg/sage_setup.rst

@@ -0,0 +1,54 @@
+.. _spkg_sage_setup:
+
+sage-setup: Build system of the Sage library
+================================================
+
+This is the build system of the Sage library, based on setuptools.
+
+
+Type
+----
+
+standard
+
+
+Dependencies
+------------
+
+- $(PYTHON)
+- $(PYTHON_TOOLCHAIN)
+- :ref:`spkg_cython`
+- :ref:`spkg_jinja2`
+- :ref:`spkg_pkgconfig`
+- :ref:`spkg_setuptools`
+
+Version Information
+-------------------
+
+package-version.txt::
+
+    10.8.1.rc0
+
+version_requirements.txt::
+
+    passagemath-setup == 10.8.1rc0
+
+Installation commands
+---------------------
+
+.. tab:: PyPI:
+
+   .. CODE-BLOCK:: bash
+
+       $ pip install passagemath-setup==10.8.1rc0
+
+.. tab:: Sage distribution:
+
+   .. CODE-BLOCK:: bash
+
+       $ sage -i sage_setup
+
+
+However, these system packages will not be used for building Sage
+because ``spkg-configure.m4`` has not been written for this package;
+see :issue:`27330` for more information.

passagemath_doc_pdf-10.8.1rc0/doc/en/reference/spkg/sage_sws2rst.rst

@@ -0,0 +1,58 @@
+.. _spkg_sage_sws2rst:
+
+sage_sws2rst: Translate legacy Sage worksheet files (.sws) to reStructuredText (.rst) files
+===========================================================================================
+
+Description
+-----------
+
+Provides a script `sage-sws2rst`, which translates a Sage worksheet file (.sws) into a reStructuredText (.rst) file.
+
+Sage worksheet files (.sws) are a file format that was used by the now-obsolete Sage notebook (https://github.com/sagemath/sagenb), superseded by the Jupyter notebook.  SageNB was dropped in the course of the transition of SageMath to Python 3.
+
+This package was extracted from the SageNB sources in :issue:`28838` to provide a way to convert pedagogical material written available in Sage worksheet format.
+
+
+Type
+----
+
+optional
+
+
+Dependencies
+------------
+
+- $(PYTHON)
+- $(PYTHON_TOOLCHAIN)
+- :ref:`spkg_beautifulsoup4`
+
+Version Information
+-------------------
+
+package-version.txt::
+
+    10.8.1.rc0
+
+version_requirements.txt::
+
+    passagemath-sws2rst == 10.8.1rc0
+
+Installation commands
+---------------------
+
+.. tab:: PyPI:
+
+   .. CODE-BLOCK:: bash
+
+       $ pip install passagemath-sws2rst==10.8.1rc0
+
+.. tab:: Sage distribution:
+
+   .. CODE-BLOCK:: bash
+
+       $ sage -i sage_sws2rst
+
+
+However, these system packages will not be used for building Sage
+because ``spkg-configure.m4`` has not been written for this package;
+see :issue:`27330` for more information.

passagemath_doc_pdf-10.8.1rc0/doc/en/reference/spkg/sagelib.rst

@@ -0,0 +1,58 @@
+.. _spkg_sagelib:
+
+=========================================================================================
+sagelib: Standard Python Library
+=========================================================================================
+
+
+This pip-installable distribution ``passagemath-standard`` is a metapackage
+that provides all standard components of the Sage library.
+
+
+Type
+----
+
+standard
+
+
+Dependencies
+------------
+
+- $(PYTHON)
+- $(PYTHON_TOOLCHAIN)
+- :ref:`spkg_sagemath_standard_no_symbolics`
+- :ref:`spkg_sagemath_symbolics`
+- :ref:`spkg_setuptools`
+
+Version Information
+-------------------
+
+package-version.txt::
+
+    10.8.1.rc0
+
+version_requirements.txt::
+
+    passagemath-standard == 10.8.1rc0
+
+See https://repology.org/project/python:sagelib/versions
+
+Installation commands
+---------------------
+
+.. tab:: PyPI:
+
+   .. CODE-BLOCK:: bash
+
+       $ pip install passagemath-standard==10.8.1rc0
+
+.. tab:: Sage distribution:
+
+   .. CODE-BLOCK:: bash
+
+       $ sage -i sagelib
+
+
+If the system package is installed and if the (experimental) option
+``--enable-system-site-packages`` is passed to ``./configure``, then 
+``./configure`` will check if the system package can be used.

passagemath_doc_pdf-10.8.1rc0/doc/en/reference/spkg/sagemath_benzene.rst

@@ -0,0 +1,100 @@
+.. _spkg_sagemath_benzene:
+
+=======================================================================================================
+sagemath_benzene: Generate fusene and benzenoid graphs with benzene
+=======================================================================================================
+
+
+This pip-installable distribution ``passagemath-benzene`` provides an interface
+to benzene, a program for the efficient generation of all nonisomorphic
+fusenes and benzenoids with a given number of faces.
+
+
+What is included
+----------------
+
+* Binary wheels on PyPI contain prebuilt copies of the benzene executable.
+
+
+Examples
+--------
+
+Using the benzene program on the command line::
+
+    $ pipx run --pip-args="--prefer-binary" --spec "passagemath-benzene[test]" sage -sh -c benzene
+
+Finding the installation location of the benzene program::
+
+    $ pipx run --pip-args="--prefer-binary" --spec "passagemath-benzene[test]" ipython
+
+    In [1]: from sage.features.graph_generators import Benzene
+
+    In [2]: Benzene().absolute_filename()
+    Out[2]: '.../bin/benzene'
+
+Using the Python interface::
+
+    $ pipx run --pip-args="--prefer-binary" --spec "passagemath-benzene[test]" ipython
+
+    In [1]: from passagemath_benzene import *
+
+    In [2]: len(list(graphs.fusenes(9, benzenoids=True)))
+    Out[2]: 6505
+
+
+Type
+----
+
+optional
+
+
+Dependencies
+------------
+
+- $(PYTHON)
+- $(PYTHON_TOOLCHAIN)
+- :ref:`spkg_benzene`
+- :ref:`spkg_cysignals`
+- :ref:`spkg_cython`
+- :ref:`spkg_gmp`
+- :ref:`spkg_mpc`
+- :ref:`spkg_mpfr`
+- :ref:`spkg_pkgconf`
+- :ref:`spkg_pkgconfig`
+- :ref:`spkg_sage_conf`
+- :ref:`spkg_sage_setup`
+- :ref:`spkg_sagemath_categories`
+- :ref:`spkg_sagemath_environment`
+- :ref:`spkg_sagemath_objects`
+- :ref:`spkg_setuptools`
+
+Version Information
+-------------------
+
+package-version.txt::
+
+    10.8.1.rc0
+
+version_requirements.txt::
+
+    passagemath-benzene == 10.8.1rc0
+
+Installation commands
+---------------------
+
+.. tab:: PyPI:
+
+   .. CODE-BLOCK:: bash
+
+       $ pip install passagemath-benzene==10.8.1rc0
+
+.. tab:: Sage distribution:
+
+   .. CODE-BLOCK:: bash
+
+       $ sage -i sagemath_benzene
+
+
+However, these system packages will not be used for building Sage
+because ``spkg-configure.m4`` has not been written for this package;
+see :issue:`27330` for more information.