Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference manual: Show package list by category (math/front-end/other) #37315

Merged
merged 15 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added build/pkgs/4ti2/math
Empty file.
Empty file added build/pkgs/admcycles/math
Empty file.
Empty file added build/pkgs/awali/math
Empty file.
Empty file added build/pkgs/barvinok/math
Empty file.
Empty file added build/pkgs/benzene/math
Empty file.
Empty file added build/pkgs/bliss/math
Empty file.
Empty file added build/pkgs/brial/math
Empty file.
Empty file added build/pkgs/buckygen/math
Empty file.
Empty file added build/pkgs/cbc/math
Empty file.
Empty file added build/pkgs/cddlib/math
Empty file.
Empty file added build/pkgs/clarabel/math
Empty file.
Empty file added build/pkgs/cliquer/math
Empty file.
Empty file added build/pkgs/cocoalib/math
Empty file.
Empty file.
Empty file.
Empty file added build/pkgs/coxeter3/math
Empty file.
Empty file added build/pkgs/cryptominisat/math
Empty file.
Empty file added build/pkgs/csdp/math
Empty file.
Empty file.
Empty file added build/pkgs/cvxopt/math
Empty file.
Empty file added build/pkgs/cvxpy/math
Empty file.
Empty file added build/pkgs/cylp/math
Empty file.
Empty file added build/pkgs/cypari/math
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file added build/pkgs/database_kohel/math
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file added build/pkgs/deformation/math
Empty file.
Empty file added build/pkgs/dot2tex/front-end
Empty file.
Empty file added build/pkgs/dsdp/math
Empty file.
Empty file added build/pkgs/e_antic/math
Empty file.
Empty file added build/pkgs/eclib/math
Empty file.
Empty file added build/pkgs/ecm/math
Empty file.
Empty file added build/pkgs/ecos_python/math
Empty file.
Empty file added build/pkgs/elliptic_curves/math
Empty file.
Empty file added build/pkgs/fflas_ffpack/math
Empty file.
Empty file added build/pkgs/flint/math
Empty file.
Empty file added build/pkgs/fplll/math
Empty file.
Empty file added build/pkgs/fpylll/math
Empty file.
Empty file added build/pkgs/fricas/math
Empty file.
Empty file added build/pkgs/frobby/math
Empty file.
Empty file added build/pkgs/gambit/math
Empty file.
Empty file added build/pkgs/gap/math
Empty file.
Empty file added build/pkgs/gap3/math
Empty file.
Empty file added build/pkgs/gap_jupyter/math
Empty file.
Empty file added build/pkgs/gap_packages/math
Empty file.
Empty file added build/pkgs/gf2x/math
Empty file.
Empty file added build/pkgs/gfan/math
Empty file.
Empty file added build/pkgs/giac/math
Empty file.
Empty file added build/pkgs/givaro/math
Empty file.
Empty file added build/pkgs/glpk/math
Empty file.
Empty file added build/pkgs/glucose/math
Empty file.
Empty file added build/pkgs/gmp/math
Empty file.
Empty file added build/pkgs/gmpy2/math
Empty file.
Empty file added build/pkgs/gp2c/math
Empty file.
Empty file added build/pkgs/graphs/math
Empty file.
Empty file added build/pkgs/graphviz/front-end
Empty file.
Empty file added build/pkgs/gsl/math
Empty file.
Empty file added build/pkgs/igraph/math
Empty file.
2 changes: 1 addition & 1 deletion build/pkgs/imagemagick/SPKG.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ImageMagick: A collection of tools and libraries for many image file formats
imagemagick: A collection of tools and libraries for many image file formats
============================================================================

Description
Expand Down
Empty file added build/pkgs/iml/math
Empty file.
Empty file added build/pkgs/ipympl/front-end
Empty file.
Empty file added build/pkgs/ipython/front-end
Empty file.
Empty file added build/pkgs/ipywidgets/front-end
Empty file.
Empty file added build/pkgs/isl/math
Empty file.
Empty file added build/pkgs/jmol/front-end
Empty file.
Empty file added build/pkgs/jupymake/math
Empty file.
Empty file.
Empty file added build/pkgs/jupyterlab/front-end
Empty file.
Empty file.
Empty file added build/pkgs/kenzo/math
Empty file.
Empty file added build/pkgs/kissat/math
Empty file.
Empty file added build/pkgs/latte_int/math
Empty file.
Empty file added build/pkgs/lcalc/math
Empty file.
Empty file added build/pkgs/libbraiding/math
Empty file.
Empty file added build/pkgs/libhomfly/math
Empty file.
Empty file added build/pkgs/libnauty/math
Empty file.
Empty file added build/pkgs/libsemigroups/math
Empty file.
Empty file added build/pkgs/lidia/math
Empty file.
Empty file added build/pkgs/lie/math
Empty file.
Empty file added build/pkgs/linbox/math
Empty file.
Empty file added build/pkgs/lrcalc/math
Empty file.
Empty file added build/pkgs/lrcalc_python/math
Empty file.
Empty file added build/pkgs/lrslib/math
Empty file.
Empty file added build/pkgs/m4ri/math
Empty file.
Empty file added build/pkgs/m4rie/math
Empty file.
Empty file added build/pkgs/mathics/math
Empty file.
Empty file added build/pkgs/mathics_scanner/math
Empty file.
Empty file added build/pkgs/matplotlib/front-end
Empty file.
Empty file.
Empty file added build/pkgs/maxima/math
Empty file.
Empty file added build/pkgs/mcqd/math
Empty file.
Empty file added build/pkgs/meataxe/math
Empty file.
Empty file.
2 changes: 1 addition & 1 deletion build/pkgs/modular_resolution/SPKG.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
p_group_cohomology: Modular cohomology rings of finite groups
modular_resolution: Modular cohomology rings of finite groups
=============================================================

Description
Expand Down
Empty file.
Empty file added build/pkgs/mpc/math
Empty file.
Empty file added build/pkgs/mpfi/math
Empty file.
Empty file added build/pkgs/mpfr/math
Empty file.
Empty file added build/pkgs/mpfrcx/math
Empty file.
Empty file added build/pkgs/mpmath/math
Empty file.
Empty file added build/pkgs/msolve/math
Empty file.
Empty file added build/pkgs/nauty/math
Empty file.
Empty file added build/pkgs/nbconvert/front-end
Empty file.
Empty file added build/pkgs/networkx/math
Empty file.
Empty file added build/pkgs/normaliz/math
Empty file.
Empty file added build/pkgs/notebook/front-end
Empty file.
Empty file added build/pkgs/ntl/math
Empty file.
Empty file added build/pkgs/numpy/math
Empty file.
Empty file added build/pkgs/openblas/math
Empty file.
Empty file added build/pkgs/ore_algebra/math
Empty file.
Empty file added build/pkgs/osqp_python/math
Empty file.
Empty file.
Empty file added build/pkgs/palp/math
Empty file.
Empty file added build/pkgs/pandoc/front-end
Empty file.
Empty file added build/pkgs/papilo/math
Empty file.
Empty file added build/pkgs/pari/math
Empty file.
Empty file added build/pkgs/pari_elldata/math
Empty file.
Empty file added build/pkgs/pari_galdata/math
Empty file.
Empty file added build/pkgs/pari_galpol/math
Empty file.
Empty file added build/pkgs/pari_jupyter/math
Empty file.
Empty file added build/pkgs/pari_nftables/math
Empty file.
Empty file added build/pkgs/pari_seadata/math
Empty file.
Empty file.
4 changes: 2 additions & 2 deletions build/pkgs/pdf2svg/SPKG.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
pdf2svg - PDF to SVG convertor
==============================
pdf2svg: PDF to SVG convertor
=============================

Description
-----------
Expand Down
Empty file added build/pkgs/pdf2svg/front-end
Empty file.
Empty file added build/pkgs/phitigra/math
Empty file.
Empty file added build/pkgs/planarity/math
Empty file.
Empty file added build/pkgs/plantri/math
Empty file.
Empty file added build/pkgs/polylib/math
Empty file.
Empty file added build/pkgs/polymake/math
Empty file.
Empty file added build/pkgs/polytopes_db/math
Empty file.
Empty file added build/pkgs/polytopes_db_4d/math
Empty file.
Empty file added build/pkgs/ppl/math
Empty file.
Empty file added build/pkgs/pplpy/math
Empty file.
Empty file added build/pkgs/primecount/math
Empty file.
Empty file added build/pkgs/primecountpy/math
Empty file.
Empty file added build/pkgs/primesieve/math
Empty file.
Empty file added build/pkgs/pycosat/math
Empty file.
Empty file added build/pkgs/pycryptosat/math
Empty file.
Empty file added build/pkgs/pygraphviz/front-end
Empty file.
Empty file added build/pkgs/pynormaliz/math
Empty file.
Empty file added build/pkgs/pyscipopt/math
Empty file.
Empty file added build/pkgs/pysingular/math
Empty file.
Empty file added build/pkgs/python_igraph/math
Empty file.
Empty file added build/pkgs/qdldl_python/math
Empty file.
Empty file added build/pkgs/qepcad/math
Empty file.
Empty file added build/pkgs/qhull/math
Empty file.
Empty file added build/pkgs/r/math
Empty file.
Empty file added build/pkgs/r_jupyter/math
Empty file.
Empty file added build/pkgs/rpy2/math
Empty file.
Empty file added build/pkgs/rst2ipynb/front-end
Empty file.
Empty file added build/pkgs/rubiks/math
Empty file.
Empty file added build/pkgs/rw/math
Empty file.
Empty file added build/pkgs/saclib/math
Empty file.
Empty file added build/pkgs/sage_flatsurf/math
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file added build/pkgs/sagetex/front-end
Empty file.
Empty file added build/pkgs/scip/math
Empty file.
Empty file added build/pkgs/scip_sdp/math
Empty file.
Empty file added build/pkgs/scipy/math
Empty file.
Empty file added build/pkgs/scs/math
Empty file.
Empty file added build/pkgs/singular/math
Empty file.
Empty file.
Empty file added build/pkgs/sirocco/math
Empty file.
Empty file added build/pkgs/slabbe/math
Empty file.
Empty file added build/pkgs/snappy/math
Empty file.
Empty file added build/pkgs/soplex/math
Empty file.
Empty file added build/pkgs/suitesparse/math
Empty file.
Empty file added build/pkgs/surf/math
Empty file.
Empty file.
Empty file added build/pkgs/symengine/math
Empty file.
Empty file added build/pkgs/symengine_py/math
Empty file.
Empty file added build/pkgs/symmetrica/math
Empty file.
Empty file added build/pkgs/sympow/math
Empty file.
Empty file added build/pkgs/sympy/math
Empty file.
Empty file added build/pkgs/tachyon/front-end
Empty file.
Empty file added build/pkgs/tdlib/math
Empty file.
Empty file added build/pkgs/texlive/front-end
Empty file.
Empty file added build/pkgs/threejs/front-end
Empty file.
Empty file added build/pkgs/tides/math
Empty file.
Empty file added build/pkgs/topcom/math
Empty file.
65 changes: 62 additions & 3 deletions src/doc/bootstrap
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ if [ "${BOOTSTRAP_QUIET}" = "no" ]; then
fi
OUTPUT_INDEX="$OUTPUT_DIR"/index.rst
cat > "$OUTPUT_INDEX" <<EOF
.. _spkg:

Packages and Features
=====================
Expand All @@ -97,24 +98,68 @@ The Sage distribution includes most programs and libraries on which
Sage depends. It installs them automatically if it does not find
equivalent system packages.

Mathematics
~~~~~~~~~~~

EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst --has-file math :standard: | grep -v '^sagemath_'); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"
cat >> "$OUTPUT_INDEX" <<EOF

Front-end, graphics, document preparation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst :standard: | grep -v '^sagemath_'); do
for PKG_BASE in $(sage-package list --has-file SPKG.rst --no-file math --has-file front-end :standard: | grep -v '^sagemath_'); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"
cat >> "$OUTPUT_INDEX" <<EOF

Other dependencies
~~~~~~~~~~~~~~~~~~

EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst --no-file math --no-file front-end :standard: | grep -v '^sagemath_'); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"
cat >> "$OUTPUT_INDEX" <<EOF


Optional Packages
-----------------

For additional functionality, you can install some of the following
optional packages.

Mathematics
~~~~~~~~~~~

EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst :optional: | grep -v '^sagemath_'); do
for PKG_BASE in $(sage-package list --has-file SPKG.rst --has-file math :optional: | grep -v '^sagemath_'); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"
cat >> "$OUTPUT_INDEX" <<EOF

Front-end, graphics, document preparation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst --no-file math --has-file front-end :optional: | grep -v '^sagemath_'); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"
cat >> "$OUTPUT_INDEX" <<EOF

Other dependencies
~~~~~~~~~~~~~~~~~~

EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst --no-file math --no-file front-end :optional: | grep -v '^sagemath_'); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"
cat >> "$OUTPUT_INDEX" <<EOF


Features
--------

Expand Down Expand Up @@ -170,13 +215,27 @@ Some packages that provide additional functionality are marked as
"experimental". Developers are needed in order to improve the
integration of these packages into the Sage distribution.

Mathematics
~~~~~~~~~~~

EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst :experimental: | grep -v '^sagemath_'); do
for PKG_BASE in $(sage-package list --has-file SPKG.rst --has-file math :experimental: | grep -v '^sagemath_'); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"

cat >> "$OUTPUT_INDEX" <<EOF

Other dependencies
~~~~~~~~~~~~~~~~~~

EOF
for PKG_BASE in $(sage-package list --has-file SPKG.rst --no-file math :experimental: | grep -v '^sagemath_'); do
echo "* :ref:\`spkg_$PKG_BASE\`"
done >> "$OUTPUT_INDEX"

cat >> "$OUTPUT_INDEX" <<EOF


All External Packages
---------------------

Expand Down
10 changes: 3 additions & 7 deletions src/doc/en/developer/coding_basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ General Conventions
===================


There are many ways to contribute to Sage including sharing scripts
and Sage worksheets that implement new functionality using Sage,
There are many ways to contribute to Sage, including sharing scripts
and Jupyter notebooks that implement new functionality using Sage,
improving to the Sage library, or to working on the many underlying
libraries distributed with Sage [1]_.
libraries distributed with Sage, see :ref:`spkg`.
This guide focuses on editing the Sage library itself.

Sage is not just about gathering together functionality. It is about
Expand All @@ -20,10 +20,6 @@ mathematically. In the design of Sage, the semantics of objects, the
definitions, etc., are informed by how the corresponding objects are
used in everyday mathematics.

.. [1]
See https://www.sagemath.org/links-components.html for a full list
of packages shipped with every copy of Sage
To meet the goal of making Sage easy to read, maintain, and improve,
all Python/Cython code that is included with Sage should adhere to the
style conventions discussed in this chapter.
Expand Down
10 changes: 3 additions & 7 deletions src/doc/en/developer/coding_in_other.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ When writing code for Sage, use Python for the basic structure and
interface. For speed, efficiency, or convenience, you can implement
parts of the code using any of the following languages: :ref:`Cython
<chapter-cython>`, C/C++, Fortran 95, GAP, Common Lisp, Singular, and
PARI/GP. You can also use all C/C++ libraries included with Sage
[SageComponents]_. And if you are okay with your code depending on
optional Sage packages, you can use Octave, or even Magma,
PARI/GP. You can also use all C/C++ libraries included with Sage,
see :ref:`spkg`. And if you are okay with your code depending on
external programs, you can use Octave, or even Magma,
Mathematica, or Maple.

In this chapter, we discuss interfaces between Sage and :ref:`PARI
Expand Down Expand Up @@ -753,7 +753,3 @@ These are only excerpts from ``octave.py``; check that file for more
definitions and examples. Look at other files in the directory
``SAGE_ROOT/src/sage/interfaces/`` for examples of interfaces to other
software packages.


.. [SageComponents] See http://www.sagemath.org/links-components.html
for a list
37 changes: 25 additions & 12 deletions src/doc/en/developer/packaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -776,20 +776,33 @@ optional packages.
Package tags
------------

You can mark a package as "huge" by placing an empty file named
``huge`` in the package directory. For example, the package
``polytopes_db_4d`` is a large database whose compressed tarball has a
size of 9 GB.

For some other packages, we have placed an empty file named
``has_nonfree_dependencies`` in the package directory. This is to
indicate that Sage with this package installed cannot be
redistributed, and also that the package can only be installed after
installing some other, non-free package.

We use these tags in our continuous integration scripts to filter
We use the following "tags" to organize our :ref:`index of packages in the
Reference Manual <spkg>`.

- Place an empty file named ``math`` in the package directory to make the
package appear in the "Mathematics" subsections of the index of standard,
optional, and experimental packages.

- Place an empty file name ``front-end`` in the package directory to make
the package appear in the "Front-end, graphics, document preparation"
subsections.

- Packages without these tags appear in the "Other dependencies" subsections.

We use the following tags in our continuous integration scripts to filter
out packages that we cannot or should not test automatically.

- You can mark a package as "huge" by placing an empty file named
``huge`` in the package directory. For example, the package
``polytopes_db_4d`` is a large database whose compressed tarball has a
size of 9 GB.

- For some other packages, we have placed an empty file named
``has_nonfree_dependencies`` in the package directory. This is to
indicate that Sage with this package installed cannot be
redistributed, and also that the package can only be installed after
installing some other, non-free package.


.. _section-trees:

Expand Down
Loading