Appendix A. Installation Instructions (readme.txt)

athenaCL Copyright (c) 2000-2010 Christopher Ariza and others.
athenaCL is free software, distributed under the GNU General Public License.

athenaCL 2.0.0a15
7 July 2010
This document contains the following information:

I. Platform Dependencies
II. Software Dependencies
IIIa. Quick Start Distributions
IIIb. Quick Start Installers
IVa. Installation
IVb. athenaCL via Command Line Interface
IVc. athenaCL via IDLE
IVd. athenaCL via Python Prompt
V. Documentation
VI. Contact Information
VII. Credits and Acknowledgments


athenaCL is distributed as executable cross-platform source-code. Platform-
specific distributions and installers are provided for convenience. Make sure
you have downloaded the correct archive for your platform:


Python EGG

unix (GNU/Linux, BSD), Macintosh MacOS X

Windows (any)


athenaCL requires Python 2.5 to 2.6. Python 3.0 and better is not yet supported.
There is no athenaCL binary: athenaCL interactive sessions run inside a Python
interpreter. Python is free and runs on every platform. No additional software
is required for basic athenaCL operation. Download Python here:

athenaCL produces both Csound and MIDI scores. Csound 5 is recommended; Csound
4.16 or better is required to render Csound scores. Csound is free and runs on
every platform. Download Csound here:

athenaCL produces images with various Python-based graphic output systems. These
output systems include the Python TkInter GUI library and the Python Image
Library (PIL), and may require additional Python software. Most Python
distributions include TkInter (MacOS systems may require additional
configuration); PIL is easily added to Python. Download PIL here:


All Platforms
    1. install Python 2.6
    2. decompress athenaCL distribution and place wherever desired

UNIX, Command Line Environments, Macintosh MacOS X:
    3. % python
    4. % python

For more information and additional installation options, see below.


Python Prompt
    1. double click the installer and follow the instructions
    2. start Python
    3. >>> import athenaCL.athenacl
Windows Installer (exe)
    1. double click the .exe file and follow the instructions
    2. start python.exe
    3. >>> import athenaCL.athenacl

For more information and additional installation options, see below.


Two installation methods are available: (1) placing the athenaCL directory
wherever desired, or (2) installing the athenaCL source into the Python library
with the Python Distribution Utilities (distutils). Both permit using athenaCL
as an interactive application and as a library imported in Python.

Installing athenaCL consist of running the file "", a script that
performs installation procedures.

The script can take arguments to perform optional installation
procedures. (1) the "tool" argument, on UNIX and MacOS X systems, will install a
command-line utility launcher, "athenacl," as well as a corresponding man page.
(2) the "install" argument, on all platforms, will perform a Python distutils
installation into the Python site-packages directory. (3) the "uninstall" option
will remove all athenaCL installation files and directories.


    1. decompress athenaCL
    2. place athenaCL directory wherever you like
    3. enter the athenaCL directory
    4. % python

or, to install the "athenacl" launcher and the athenaCL man page:
    4. % python tool

or, to perform a distutils installation
    4. % python install

launching from the command line interface:
    5. % python

launching with the athenaCL tool:
    5. % /usr/local/bin/athenacl

launching with the athenaCL tool and /usr/local/bin in PATH:
    5. % athenacl

IVd. athenaCL VIA IDLE:

    1. decompress athenaCL
    2. place athenaCL directory wherever you like
    3. enter the athenaCL directory
    4. double-click ""

launching on Windows:
    5. double-click ""
    6. enter "y" when asked to start athenaCL in IDLE

launching from the command line interface:
    5. % python -s idle


If the athenaCL script has been successfully completed, Python should
already by aware of the location of the current athenaCL installation. If the
athenaCL script has not been properly run, the directory containing
athenaCL must be manually added to the Python sys.path:
(if the athenaCL directory is located in the directory "/src")
    1. >>> import sys
    2. >>> sys.path.append('/src')

    3. >>> import athenaCL.athenacl


For complete documentation, tutorials, and reference, see the athenaCL Tutorial


Send questions, comments, and bug reports to:
athenaCL development is hosted at GoogleCode:


athenaCL was created and is maintained by Christopher Ariza. Numerous generator
ParameterObjects based in part on the Object-oriented Music Definition
Environment (OMDE/pmask), Copyright 2000-2001 Maurizio Umberto Puxemdu; Cmask
was created by Andre Bartetzki. The Command Line Interpreter is based in part on; the module is by Greg Ward; both are distributed with
Python, Copyright 2001-2003 Python Software Foundation. The fractional noise
implementation in, Audacity spectrum importing, and dynamic
ParameterObject boundaries are based in part on implementations by Paul Berg.
The module is based in part on code by Robert Rowe. The module is based in part on code by Bob van der Poel. The module
is based in part on code by Hans Mikelson. The module is based in
part on code by Ulrich Hoffman. Pitch class set names provided in part by Larry
Solomon. The Rabin-Miller Primality Test is based in part on an implementation
by Stephen Krenzel. The mpkg installer is generated with py2app (bdist_mpkg) by
Bob Ippolito. Python language testing done with PyChecker (by Neal Norwitz
Copyright 2000-2001 MetaSlash Inc.) and pyflakes (by Phil Frost Copyright 2005
Divmod Inc.). Thanks to the following people for suggestions and feedback: Paul
Berg, Per Bergqvist, Marc Demers, Ryan Dorin, Elizabeth Hoffman, Anthony Kozar,
Paula Matthusen, Robert Rowe, Jonathan Saggau, and Jesse Sklar. Thanks also to
the many users who have submitted anonymous bug-reports.

Apple, Macintosh, Mac OS, and QuickTime are trademarks or registered trademarks
of Apple Computer, Inc. Finale is a trademark of MakeMusic! Inc. Java is a
trademark of Sun Microsystems. Linux is a trademark of Linus Torvalds. Max/MSP
is a trademark of Cycling '74. Microsoft Windows and Visual Basic are trademarks
or registered trademarks of Microsoft, Inc. PDF and PostScript are trademarks of
Adobe, Inc. Sibelius is a trademark of Sibelius Software Ltd. is
a trademark of VA Software Corporation. UNIX is a trademark of The Open Group.