"How to get started with developing Sage"

[Martin Albrecht]

Hi there,

Sage Days 16 is coming up next week in Barcelona. On Tuesday, I will give a
talk on how to get started developing Sage. At SD16 many people are attending
who never attended a Sage Days before and thus we figured it would be nice to
provide some hand holding to get into it.

My outline so far is:

Motivation:
- a brief motivation (shouldn't be needed at this point anyway)

Overview:
- a brief comment on Python and Cython
- the pre-parser (i.e. library vs. command line)
- SPKGs and the Sage Library
- directory structure
- finding the source file for a function
- $SAGE_LOCAL/lib/site-packages/python vs. $SAGE_ROOT/devel
i.e. explain what sage -b does

Revision Control
- basically the MQ stuff from the dev guide
- how to repair your installation after you've broken it (i.e: "you can't
really mess up badly, we have MQ!")

The Sage Development Process
- Trac/Reviews: the process
- How to Review Patches

The Sage Community
- Where to ask, where are the resources etc.

So my question is:

What do people think?

If you are a developer, what do you think must be added, what are the things a
newbie should know?

If you didn't contribute code so far, what would you like to see in such a
talk?

Cheers,
Martin

--
name: Martin Albrecht
_pgp: http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x8EF0DC99
_otr: 47F43D1A 5D68C36F 468BAEBA 640E8856 D7951CCF
_www: http://www.informatik.uni-bremen.de/~malb
_jab: martinr...@jabber.ccc.de

[Minh Nguyen]

Hi Martin,

On Thu, Jun 18, 2009 at 3:20 AM, Martin
Albrecht<ma...@informatik.uni-bremen.de> wrote:
>

<SNIP>

> The Sage Development Process
> - Trac/Reviews: the process
> - How to Review Patches

Ticket #6226 might be relevant here. The patches on that ticket add
further documentation to the developer's guide, covering topics such
as using the ReST format in docstrings, questions to ask yourself when
reviewing tickets, reasons to Invalidate Tickets, etc. Such
information were taken from the following wiki page by Florent Hivert

http://wiki.sagemath.org/combinat/HelpOnTheDoc

and the following page by Michael Abshoff

http://wiki.sagemath.org/TracGuidelines

--
Regards
Minh Van Nguyen

[David Joyner]

This looks great. I'm sure you'll mention cloning but more generally
if there is time
running through all the sage flag options you see under "sage -h" and
"sage -advanced" might be a good idea.

[Jason Grout]

Martin Albrecht wrote:
> Hi there,
>

> - how to repair your installation after you've broken it (i.e: "you can't
> really mess up badly, we have MQ!")

Beware to pop all patches before sage -upgrade!

Until someone fixes sage -upgrade to look for mq patches, that is...

Jason

[John H Palmieri]

On Jun 17, 10:20 am, Martin Albrecht <m...@informatik.uni-bremen.de>
wrote:

This all sounds good. From a different point of view, if you think
topics (e.g., like the pre-parser) need to be added to the developer's
guide, or reorganized or whatever, please open a ticket.

John

[Nicolas M. Thiery]

On Wed, Jun 17, 2009 at 06:20:57PM +0100, Martin Albrecht wrote:
>
> Hi there,
>
> Sage Days 16 is coming up next week in Barcelona. On Tuesday, I will give a
> talk on how to get started developing Sage. At SD16 many people are attending
> who never attended a Sage Days before and thus we figured it would be nice to
> provide some hand holding to get into it.
>
> My outline so far is:
>
> Motivation:
> - a brief motivation (shouldn't be needed at this point anyway)
>
> Overview:
> - a brief comment on Python and Cython
> - the pre-parser (i.e. library vs. command line)
> - SPKGs and the Sage Library
> - directory structure
> - finding the source file for a function
> - $SAGE_LOCAL/lib/site-packages/python vs. $SAGE_ROOT/devel
> i.e. explain what sage -b does

Running doctests!

This includes running doctests on files that are not in the sage
source tree. I.e. we want to train every user early to write and use
doctests even in their own little libraries.

Btw: is it possible to run sage -t on a notebook?

Cheers,
Nicolas
--
Nicolas M. Thiéry "Isil" <nth...@users.sf.net>
http://Nicolas.Thiery.name/

[William Stein]

No, it would be very nice to have "sage -t foo.sws"... or something.

William

[Nicolas M. Thiery]

On Thu, Jun 18, 2009 at 04:49:10PM +0200, William Stein wrote:
> > > Btw: is it possible to run sage -t on a notebook?
>
> No, it would be very nice to have "sage -t foo.sws"... or something.

This is now: http://trac.sagemath.org/sage_trac/ticket/6356

[Nick Alexander]

> No, it would be very nice to have "sage -t foo.sws"... or something.

http://trac.sagemath.org/sage_trac/ticket/6357

Nick