I gave this talk on Thursday, 29 September 2011 during ... - Bitbucket

I <strong>gave</strong> <strong>this</strong> <strong>talk</strong> on Thursday, 29 September 2011
during Sage/Singular Days (SD34) in Kaiserslautern,
Germany.
Feel free to use the slides for your needs.
If you need an editable version, send me an E-Mail
or a message on BitBucket.
Thanks to Burcin Erocal, who organized Sage Days
34 and invited me.
Special Thanks to Michael Brickenstein for the
idea(s), the teaching and for providing many slides.
1
Niels Ranosch

About Me
Finished school in June
Will start studying Maths next month
Worked at MFO since July
Python, Sage
Citation stuff
2

Citing Sage
components
„citing and being cited“
3

Citing components
is hard
which components have been used?
which are citeworthy (for <strong>this</strong>
particular computation)?
how to tell users to cite
components?
4

Current situation
Show current situation using
get_systems() on the sage prompt
5

Example: slimgb
from sage.citation import cites, citable_items
@cites(citable_items.slimgb)
def slimgb_libsingular(I):
"""
SINGULAR's ``slimgb()`` algorithm.
6

from citable import Citable
class singular(Citable):
pass
class magma(Citable):
pass
class slimgb(singular)
pass
Citables
7
Citables can
depend on
each other
software or
articles
declares just
dependencies
data loaded
on demand

More special citables
class primdec(singular):
r"""
@misc{primdec,
}
author = {Gerhard Pfister and
Wolfram Decker and Hans Schoenemann},
title = {{\tt primdec.lib}.
{A} {\sc Singular} library for primary decomposition},
howpublished = {part of the {\sc Singular} distribution},
month = may,
year = {2001},
"""
type = "library"
8

Lazy Data Loading
if cls.filename is None:
else:
parser = find_plugin("pybtex.database.input")()
citation = parser.parse_stream(StringIO(cls.__doc__))
file = ... # filename blabla
# Guess the file's format
parser = find_plugin("pybtex.database.input", filename=file)()
citation = parser.parse_file(file)
cls.__class__ = CitableType
cls.citation = citation
9

Live Demo
Show new citation system on the sage prompt
10

Software Citations are
essential for components
The development of many Sage
components strongly depends on proper
citation.
The Sage community already tries very
hard to achieve the best citation
practices
Every progress in <strong>this</strong> domain will
increase the reputation of the Sage
project.
11

Need to measure
that
By its large user base Sage increases the
number of users of most of its
components significantly.
Even if not all of them cite components
properly, citations for each component
should increase signicifantly.
How to measure that? Make sure
citations are trackable.
12

Who knows how to
cite math software
And how can we track that?
13

The current practice
of citing software:
Everybody uses his personally best way
to cite software
14

Official
recommendations
In general, there exists no
standard way of citing software
However for some software, there
exist recommendations, sometimes
they are even followed
15

How to cite Singluar
If you have used Singular in the preparation of a
publication, please use the following BibTeX entry (with
adjusted Singular version and year, here 3.1.2 and 2010,
respectively):
@article {DGPS,
}
title = {{\sc Singular} {3-1-3} ---
year = {2011},
{A} computer algebra system for
polynomial computations},
author = {Decker, W.; Greuel, G.-M.; Pfister, G.;
Sch{\"o}nemann, H.},
note = {http://www.singular.uni-kl.de},
16

How to cite Singluar
If you have used Singular in the preparation of a
publication, please use the following BibTeX entry (with
adjusted Singular version and year, here 3.1.2 and 2010,
respectively):
@article {DGPS,
title = {{\sc Singular} {3-1-3} ---
year = {2011},
{A} computer algebra system for
polynomial computations},
author = {Decker, W.; Greuel, G.-M.; Pfister, G.;
Sch{\"o}nemann, H.},
note = {http://www.singular.uni-kl.de},
journal ?
17
???

@misc {DGPS,
}
title = {{\sc Singular} {3-1-3} ---
year = {2011},
{A computer algebra system for
polynomial computations}},
author = {Decker, W. and Greuel, G.-M.
and Pfister, G.
and Sch\"{o}nemann, H.},
note = {http://www.singular.uni-kl.de},
not bad, but tracking requires heavy
string matching heuristic
18

@article {MR1484478,
}
AUTHOR = {Bosma, Wieb and Cannon, John and Playoust, Catherine},
TITLE = {The {M}agma algebra system. {I}. {T}he user language},
NOTE = {Computational algebra and number theory (London, 1993)},
JOURNAL = {J. Symbolic Comput.},
FJOURNAL = {Journal of Symbolic Computation},
VOLUME = {24},
YEAR = {1997},
NUMBER = {3-4},
PAGES = {235--265},
ISSN = {0747-7171},
MRCLASS = {68Q40},
MRNUMBER = {MR1484478},
DOI = {10.1006/jsco.1996.0125},
URL = {http://dx.doi.org/10.1006/jsco.1996.0125},
wonderful, has a DOI
19

@article {MR1484478,
}
AUTHOR = {Bosma, Wieb and Cannon, John and Playoust, Catherine},
TITLE = {The {M}agma algebra system. {I}. {T}he user language},
NOTE = {Computational algebra and number theory (London, 1993)},
JOURNAL = {J. Symbolic Comput.},
FJOURNAL = {Journal of Symbolic Computation},
VOLUME = {24},
YEAR = {1997},
NUMBER = {3-4},
PAGES = {235--265},
ISSN = {0747-7171},
MRCLASS = {68Q40},
MRNUMBER = {MR1484478},
DOI = {10.1006/jsco.1996.0125},
URL = {http://dx.doi.org/10.1006/jsco.1996.0125},
But: Look at the year!
20

@manual{M4RI,
}
or cite one of the papers
key = "M4RI",
author = "Martin Albrecht and Gregory Bard",
organization = "The M4RI~Team",
title = "{The M4RI Library -- Version 20100817}",
year = 2010,
regarding specific
functionality
url = "\url{http://m4ri.sagemath.org}",
similarly tracking problems like
Singular except much better name
21

How to find out that it is a software
citation?
How to exactly identify software from
your database?
How to handle small textual variations?
How to treat software not in the
database?
How to find out the version number?
22

Even if users adapt to official
recommendations, software
citations are very hard to track
23

Our suggestions
@misc{libgeneric,
}
howpublished = {\url{http://generic.heaven.edu}},
note = {version 3.3},
title = {libgeneric},
author = {Michael Ende},
month = {May},
year = {1979}
24

Our suggestions
"trackable", if it fulfills one of the following
criteria
the software name is very unique and very
easily trackable
it includes a URL which is specific to <strong>this</strong>
software (and to <strong>this</strong> version?)
represents an article and include its DOI.
Alternative 1 and 2 are still prone to false
positives, but we assume the dimension is
acceptable.
25