#3317: a citation system for Sage components
-------------------------------------------------+-------------------------
Reporter: mhampton | Owner: mhampton
Type: enhancement | Status:
Priority: major | needs_review
Component: packages: standard | Milestone: sage-
Keywords: citations, sd34 | feature
Authors: Niels Ranosch, Michael | Resolution:
Brickenstein, Burcin Erocal | Merged in:
Report Upstream: N/A | Reviewers:
Branch: | Work issues:
Dependencies: #11851, #11852 | Commit:
| Stopgaps:
-------------------------------------------------+-------------------------
Changes (by burcin):
* type: task => enhancement
Old description:
> Sage could use some sort of citation system that identifies what
> components/packages are used in a given computation or worksheet. After
> some discussion, it is unclear what the architecture of that should be.
>
> ----
>
> Only apply:
> * [http://trac.sagemath.org/sage_trac/attachment/ticket/3317/trac-3317
> -citation-environment.patch trac-3317-citation-environment.patch]
> * [http://trac.sagemath.org/sage_trac/attachment/ticket/3317/trac-3317
> -citation-system.patch trac-3317-citation-system.patch]
> * [http://trac.sagemath.org/sage_trac/attachment/ticket/3317/trac-3317
> -bibtex-data.patch trac-3317-bibtex-data.patch]
> * [http://trac.sagemath.org/sage_trac/attachment/ticket/3317/trac-3317
> -example-usage.patch trac-3317-example-usage.patch]
New description:
This ticket implements a citation tracking system for Sage which can give
fine grained information on the algorithms and implementations used for a
specific computation.
This is in contrast to the current method in `sage.misc.citation` that
relies on running a smaller example through the profiler.
The new citation module allows developers to add annotations with citation
data in the code directly via decorators tuned to minimize performance
overhead. Citations can be provided and obtained in several different
formats, thanks to the [http://pybtex.sourceforge.net/ pybtex] package.
This includes bibtex and plain text output.
Sample user session:
{{{
sage: R.<x,y,z> = QQ[]
sage: print citations
[1] W. Decker, G.-M. Greuel, G. Pfister, and H. Schoenemann.
{\sc Singular} {3-1-3} --- {A} computer algebra system for polynomial
computations. 2011, http://www.singular.uni-kl.de.
sage: p = z^2 + 1; q = z^3 + 2
sage: I = (p*q^2, y-z^2)*R
sage: t = I.complete_primary_decomposition()
sage: print citations
[1] Takeshi Shimoyama and Kazuhiro Yokoyama. Localization and primary
decomposition of polynomial ideals. J. Symb. Comput., 22:247-277,
September 1996.
[2] Gerhard Pfister, Wolfram Decker, and Hans Schoenemann. {\tt
primdec.lib}. {A} {\sc Singular} library for primary decomposition.
Part of the {\sc Singular} distribution, May 2001.
[3] W. Decker, G.-M. Greuel, G. Pfister, and H. Schoenemann. {\sc
Singular} \{3-1-3} --- {A} computer algebra system for polynomial
computations. 2011, http://www.singular.uni-kl.de.
}}}
If a different algorithm is requested, the citations reflect this change:
{{{
sage: citations.clear()
sage: t = I.complete_primary_decomposition(algorithm='gtz')
sage: print citations
[1] Patrizia Gianni, Barry Trager, and Gail Zacharias. Groebner bases and
primary decomposition of polynomial ideals. J. Symb. Comput., 6:149-167,
December 1988.
[2] Gerhard Pfister, Wolfram Decker, and Hans Schoenemann. {\tt
primdec.lib}. {A} {\sc Singular} library for primary decomposition.
Part of the {\sc Singular} distribution, May 2001.
[3] W. Decker, G.-M. Greuel, G. Pfister, and H. Schoenemann. {\sc
Singular} {3-1-3} --- {A} computer algebra system for polynomial
computations. 2011, http://www.singular.uni-kl.de.
}}}
----
Only apply:
* [http://trac.sagemath.org/sage_trac/attachment/ticket/3317/trac-3317
-citation-environment.patch trac-3317-citation-environment.patch]
* [http://trac.sagemath.org/sage_trac/attachment/ticket/3317/trac-3317
-citation-system.patch trac-3317-citation-system.patch]
* [http://trac.sagemath.org/sage_trac/attachment/ticket/3317/trac-3317
-bibtex-data.patch trac-3317-bibtex-data.patch]
* [http://trac.sagemath.org/sage_trac/attachment/ticket/3317/trac-3317
-example-usage.patch trac-3317-example-usage.patch]
--
--
Ticket URL: <http://trac.sagemath.org/ticket/3317#comment:28>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
