Added some docs
[linpy.git] / examples / README.rst
1
2 ========
3 Examples
4 ========
5
6 This directory contains pypol examples programs.
7
8 Running Examples
9 ================
10
11 To run the individual examples one needs to have Python version ≥ 3.4 installed and pypol must be in your ``PYTHONPATH`` environment variable.
12 Most examples can be run from the command line ``python3`` and the name of the example::
13
14 vivien@rochefort:~/pypol/examples$ export PYTHONPATH=$PWD/..:$PYTHONPATH
15 vivien@rochefort:~/pypol/examples$ python3 squares.py
16
17 Note: on most systems, the current directory is searched by Python automatically, so ``python3 examples/squares.py`` works from the pypol root directory, however there are systems (Ubuntu Intrepid) where this doesn't work by default, unless you put ``PYTHONPATH=.`` into your .bashrc for example.