[Pythonsound-devel] Re: [Csnd] Pmask manual (fwd)

[Maurizio U. P. <um...@ti...>]

The __doc__ stringn example below is already obsolete!

---------- Forwarded message ----------
Date: Tue, 2 Oct 2001 00:08:09 +0200
From: um...@ti...
To: cs...@li...
Cc: um...@ti...
Subject: Re: [Csnd] Pmask manual

On Mon, 1 Oct 2001, Gabriel Maldonado wrote:
> Does it exist a Pmask manual? If it does, where can I get it?

The short answer is: no, there is no decent manual for pmask, only few examples in the examples/ directory.
Moreover the development version of OMDE/pmask, available via CVS as
described here

http://sourceforge.net/cvs/?group_id=15938

is different in several ways from the last release (probably 0.12).
If you
The first release as OMDE/pmask will be fully documented with doc-strings.
This means that you are (in some cases now, in all cases in future) able to
get info about a class or a function this way:

[maurizio@maderna Bocca2]$ python
Python 2.0 (#2, May 22 2001, 11:42:51)
[GCC 2.96 20000731 (Red Hat Linux 7.1 2.96-81)] on linux2
Type "copyright", "credits" or "license" for more information.
>>> import pmask
>>> print pmask.cloud.__doc__

    Generate an Aggregate of events using the cmask generation model.
    You can use any callable as event generator using

    Class = Contructor

    the default constructor is I.
    Constructor should return an Event or an Aggregate and must take
    at least 3 arguments: instrument number, onset time and duration

    Use

    Class = DebugCTOR

    to print generated values instead of actually generate something.
    An empty aggregate will be returned in this case.

>>>

or get a printable or browseable version of a reference manual using happydoc.
I'm currently using OMDE/pmask to complete two composition and extending
it every day. As I finish them (approx end of this month), I intend to prepare a fully
documented candidate release, submit it to people that was interested and/or
using pmask and possibly collect their comments, then release OMDE/pmask.
At the moment, if you need some explanation, just ask me.
If you are going to start to use pmask or want to give it a try, I strongly
suggest you to try the CVS version of OMDE/pmask. I'm using it every day so
it works quite well and if you find some bug I can fix it quickly.
Reports about design issues are welcome but not likely to be faces before 1 month.

If you and CVS are not simpatico, contact me privately.

Maurizio Umberto Puxeddu