File: README.rst

package info (click to toggle)
pysurfer 0.3%2Bgit15-gae6cbb1-1.1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 2,032 kB
  • sloc: python: 1,947; makefile: 125
file content (17 lines) | stat: -rw-r--r-- 746 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
PySurfer Examples
=================

This directory contains a set of example scripts intended to demonstrate the
functionality offered by PySurfer, from the most basic tasks to more complicated
visualizations. It also serves as a test suite for the visualization module,
which is difficult to test numerically.

Any example with a filename that begins with ``plot`` will be executed when
the documentation is built, with any figures build during execution captured
and saved in the html file.

The automatic doc engine writes an example index by the alphabetical filename,
and the general intention is to move from basic examples to more complex tasks.
Please keep this in mind when naming example scripts.

Contributions are more than welcome!