Differences between revisions 8 and 19 (spanning 11 versions)
⇤ ← Revision 8 as of 2017-02-22 17:29:53 →
Size: 10671
Editor: mrennekamp
Comment: add through end of f's
← Revision 19 as of 2022-04-05 02:16:14 → ⇥
Size: 0
Editor: mkoeppe
Comment: outdated
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
This page is intended for ''users''. Developers, see Trac.

Possibly more clear lists of spkg's are on [[http://files.sagemath.org/spkg/]].

[[https://trac.sagemath.org/|Trac]] (the wiki) provides minimal information in regards to "dependencies" (upstream).

The Sage [[http://doc.sagemath.org/html/en/developer/index.html|Developer Guide]] includes some information on including packages into the source code.

= SPKGs =
Update this table based on [[https://git.sagemath.org/sage.git/tree/build/pkgs]].
||'''Spkg''' ||'''Upstream Weblink''' ||'''Includes a spkg-src? (NY = updates manually)''' ||'''Purpose''' ||'''Standard?''' ||
|| 4ti2 ||[[http://www.4ti2.de/]] || NY ||A software package for algebraic, geometric, combinatoric problems on linear spaces ||Optional ||
|| alabaster ||[[http://alabaster.readthedocs.io/]] || NY ||Default theme for Sphinx ||Standard ||
|| appnope ||[[https://github.com/minrk/appnope]] || NY ||Disables App Nap on OSX 10.9 ||Standard ||
|| arb ||[[https://arblib.org/]] [[http://github.com/fredrik-johansson/arb/]]|| NY ||C library for arbitrary-precision interval arithmetic ||Standard ||
|| atlas ||[[http://math-atlas.sourceforge.net/]] ||(AUTO UPDATES PER INSTALL) ||Linear Algebra (packages) ||Optional ||
|| autotools ||[[https://www.gnu.org/software/automake/]] ||(AUTO UPDATES PER INSTALL) ||GNU Build System ||Optional ||
|| babel ||[[http://babel.pocoo.org/]] || NY ||Internationalization utilities ||Standard ||
|| backports_abc ||[[https://pypi.python.org/pypi/backports_abc]] || NY || Backports "collections.abc" (PyPi) ||Standard ||
|| backports_shutil_get_terminal_size || PyPi || NY || A backport of the get_terminal_size function from Python 3.3's shutil. ||Standard ||
|| backports_ssl_match_hostname || PyPi || NY || The ssl.match_hostname() function from Python 3.5 || Standard ||
|| beautifulsoup || [[https://www.crummy.com/software/BeautifulSoup/]] || ? || Screen-scraping library (sits atop html/xml parser) || "pip" ||
|| benzene || ? Assuming http://www.grinvin.org/ || NY || Efficient generation of all nonisomorphic fusenes and benzenoids || Optional ||
|| biopython || [[http://biopython.org/]] || ? || Python tools for computational molecular biology || "pip" ||
|| bliss || [[http://www.tcs.tkk.fi/Software/bliss]]|| (AUTO UPDATES) ||Computing automorphism groups and canonical forms of graphs || Optional ||
|| boost || [[http://www.boost.org/]]|| NY || "Portable C++ Libraries" || Optional ||
|| boost_cropped || Same as above || includes spkg-src || ? || Standard ||
|| brial || [[https://github.com/BRiAl/BRiAl]] || NY || Various; successor to PolyBoRi || Standard ||
|| brian || [[https://pypi.python.org/pypi/brian]] [[http://briansimulator.org/]] || ? || A clock-driven simulator for spiking neural networks || "pip" ||
|| buckygen || [[http://caagt.ugent.be/buckygen/]] || NY || Efficient generation of all nonisomorphic fullerenes || Optional ||
|| bzip2 || [[http://www.bzip.org/]] || (AUTO UPDATES) || Data compressor || Standard ||
|| cbc || [[https://projects.coin-or.org/Cbc]] || NY || Open-source mixed integer programming solver written in C++ || Optional ||
|| ccache || [[https://ccache.samba.org/]] || NY || Compiler cache; supports C, C++, Objective-C, and Objective-C++ || Optional ||
|| cddlib ||[[https://www.inf.ethz.ch/personal/fukudak/cdd_home/]]|| (AUTO UPDATES) ||C implementation of the Double Description Method of Motzkin||Standard||
|| cephes || [[http://www.moshier.net/]] || NY || Mathematical library in/for C || Standard||
|| certifi || [[http://certifi.io/]] || NY || Python package for providing Mozilla's CA Bundle || Standard ||
|| cliquier || [[https://users.aalto.fi/~pat/cliquer.html]] || (AUTO UPDATES) ||Set of C routines for finding cliques in an arbitrary weighted graph ||Standard||
|| cmake || [[https://cmake.org/]] || NY || CMake is a cross-platform build system generator || Experimental ||
|| combinatoral_designs || ? || NY || Data for combinatoral designs || Standard ||
|| compilerwrapper || [[https://bitbucket.org/vbraun/compilerwrapper]] || NY || A wrapper for compiler and binutils || Experimental ||
|| configparser || [[https://docs.python.org/3/library/configparser.html]] || NY || Exists for compatiblity with Python2 || Standard ||
|| configure || Auto-generated by Sage || Auto-generated by Sage || shipped in case sufficiently recent autotools not installed || Base ||
|| conway_polynomials || extends Sage library || NY? || Small database of Conway Polynomials || Standard ||
|| coxeter3 || [[http://math.univ-lyon1.fr/~ducloux/coxeter/coxeter3/english/coxeter3_e.html]] || NY || Wraps Fokko Ducloux's Coxeter 3 C++ library || Optional||
|| cryptominisat || [[https://www.msoos.org/]] || NY || (To be) an efficient sequential, parallel and distributed solver || Experimental ||
|| csdp || [[https://projects.coin-or.org/Csdp]] || (AUTO UPDATES) || A fast SDP solver written in C || Optional ||
|| cvxopt || [[http://cvxopt.org/]] || NY || Convex optimization based on Python || Standard ||
|| cycler || [[http://matplotlib.org/cycler/]] || NY || A small break of of matplotlib to deal with "composable cycles" || Standard ||
|| cysignals || [[https://github.com/sagemath/cysignals]] || NY || Interrupt and signal handling for Cython || Standard ||
|| cython || [[http://cython.org/]] || NY || C extensions for Python || Standard ||
|| d3js || [[https://d3js.org/]] || (AUTO UPDATES) || JavaScript library for manipulating documents based on data || Optional ||
|| database_cremona_ellcurve || [[https://github.com/JohnCremona/ecdata]] || NY || John Cremona's database of elliptic curves || Optional ||
|| database_gap || [[https://www.gap-system.org/]] || (AUTO UPDATE) || The databases of GAP: finite groups and tables of marks || Optional ||
|| database_kohel ||
|| database_mutation_class ||
|| database_odlyzko_zeta ||
|| database_pari ||
|| database_stein_watkins ||
|| database_stein_watkins_mini ||
|| database_symbolic_data ||
|| dateutil || [[https://pypi.python.org/pypi/python-dateutil]] || NY || Extensions to Python dateutil || Standard ||
|| decorator || ? || NY || "Better living through Python with decorators" || Standard ||
|| docutils || [[http://docutils.sourceforge.net/]] || NY || A modular system for processing documentation into useful formats, such as HTML, XML, and LaTeX.|| Standard ||
|| doc2tex || [[https://pypi.python.org/pypi/dot2tex]] || NY || A Graphviz to LaTeX converter || Optional ||
|| ecl || [[https://common-lisp.net/project/ecl/]] || (AUTO UPDATES) || Implementation of the Common Lisp language || Standard ||
|| eclib || [[https://github.com/JohnCremona/eclib]] || NY || Enumerating and computing with elliptic curves defined over the rational numbers || Standard ||
|| ecm || [[http://gforge.inria.fr/projects/ecm/]] || NY || Elliptic Curve Method for Integer Factorization || Standard ||
|| elliptic_curves || || NY || Two databases for elliptic curves, from John Cremona and William Stein || Standard ||
|| entrypoints || [[https://github.com/takluyver/entrypoints]] || NY, but also has special setup || Discover and load entry points from installed packages || Standard||
|| fflas_ffpak || [[http://www.linalg.org/linbox/fflas-ffpack/]] || NY || Source code library for dense linear algebra over word-size finite fields ||Standard ||
|| flask || [[http://flask.pocoo.org/]] || NY || Web micro-framework || Standard||
|| flask_autoindex || ? || NY || The mod_autoindex for Flask || Standard ||
|| flask_babel || ? || NY || Adds i18n/l10n support to Flask applications || Standard ||
|| flask_oldsessions || ? || NY || Provides a session class || Standard ||
|| flask_openid || ? || NY || OpenID support for Flask || Standard||
|| flask_silk || ? || NY || Adds silk icons to your Flask application or blueprint, or extension || Standard ||
|| flint || [[http://www.flintlib.org/]] || NY || Fast Library for Number Theory || Standard ||
|| flintqs || [[http://www.friedspace.com/QS/]] || NY || Multi-polynomial quadratic sieve for integer factorization || Standard ||
|| fyplll || [[https://github.com/fplll/fpylll]] || NY || Python interface for fpll (Lattice algorithms using floating-point arithmetic) || Standard ||
|| freetype || [[https://www.freetype.org/]] || NY || Software library to render fonts || Standard ||
|| fricas || [[https://fricas.sourceforge.net/]] || NY || Advanced CAS || Experimental ||
|| frobby || [[http://www.broune.com/frobby/]] || NY || Provides a number of computations on monomial ideals || Optional ||
|| functools32 || [[https://pypi.python.org/pypi/functools32]] || NY || Backport of the functools module from Python 3.2.3 || Standard ||
|| future || [[https://pypi.python.org/pypi/future/]] || NY || future is the missing compatibility layer between Python 2 and Python 3 || Standard ||

||'''Spkg ''' ||'''Current spkg Maintainer(s)''' ||'''Version in Sage''' ||'''Latest Stable Release''' ||'''Removed In''' ||
|| [[spkg/pysqlite|pysqlite]] || || || || ||
|| [[spkg/ipython1|ipython1]] || || || || Sage 3.3 ||

= What is a spkg? =

Files with the extension ".spkg" are known as Sage packages. The directory {{{SAGE_ROOT/spkg/standard}}} contains the standard SPKG's. In a source install of Sage, this directory contains all the standard Sage spkg files (actually .tar or .tar.bz2 files), which are the source code that defines Sage. In a binary install, some of these may be small placeholder files to save space.

Sage packages are distributed as ".spkg" files, which are .tar.bz2 files (or tar files) but have the extension ".spkg" to discourage confusion. Although Sage packages are packed using tar and/or bzip2, please note that ".spkg" files contain control information (installation scripts and metadata) that are necessary for building and installing them. For source distributions, when you compile Sage the file {{{SAGE_ROOT/makefile}}} takes care of the unpacking, compilation, and installation of Sage packages for you. For more information on the structure of {{{.spkg}}} files, please refer to the Sage Developer's Guide
in your local installation of Sage at
{{{
SAGE_ROOT/sage/doc/output/html/en/developer/index.html
}}}
If you cannot locate that file in your local installation of Sage, you might want to consider (re)building the standard Sage documentation using this command:
{{{
SAGE_ROOT/sage -docbuild all html
}}}
or refer to the [[http://www.sagemath.org/doc/developer/|online Sage developer's guide]]. Additional Sage packages can be found at the [[http://www.sagemath.org/download-packages.html|packages download page]].