Cyrano Home

Cyrano is a tool used for demonstrating Python packages that combines a display window and an IPython shell.

Cyrano displays demonstration scripts one section at a time.
By clicking buttons, Cyrano will type lines or sections of your demo for you.
You can intermix interactive Python commands in the IPython pane.
Many Cyrano features (.e.g. colors) are configurable with a simple Python RC file.

Optionally, Cyrano can embed one matplotlib Figure as shown below:

Wiki/Trac

https://svn.stsci.edu/trac/ssb/etal/wiki/Cyrano

Subversion

https://svn.stsci.edu/trac/ssb/etal/browser/cyrano/trunk

Download

Cyrano is a pure Python package. Stable source releases are here:

Cyrano v0.1.4

Rough changes between versions are here: CHANGES

Old versions are here: v0.1 v0.1.1 v0.1.2 v0.1.3

Basic Installation

Install Cyrano on Mac or Linux systems by opening a terminal window and doing this:

% tar zxf cyrano-0.1.4.tar.gz
% cd cyrano-0.1.4
% python setup.py install
% cp cyrano ...somewhere on your path...

Since we don't use it ourselves and since it didn't "just work", Windows is not yet a supported platform.

Configuration and Use

Cyrano's basic usage is defined here: README

Cyrano's default configuration is defined by config.py which can be copied to $HOME/.cyranorc and edited to configure Cyrano.

Dependencies

Cyrano requires these additional Python packages in order to run:

Optionally Cyrano can make use of matplotlib for integrated plotting but it is not required:


Pmw	v1.3.2 or later, found here: SourceForge (original) or stsci (cache)
IPython	v0.9.1 or later, found here: scipy.org (original) or stsci (cache)
matplotlib (optional)	v0.99 or later, found here: sourceforge.net (original) or stsci (cache)

Acknowledgements

Special thanks go to Perry Greenfield and Victoria Laidler who helped debug Cyrano and used it in their own presentations.

Additional thanks go to: Accerciser, Pmw, and IPython whose excellent components were used to make Cyrano.

Questions? Contact help@stsci.edu
Last updated: 18 August 2009