pprocess

README.txt

50:bee0a934d1aa
2006-10-01 paulb [project @ 2006-10-01 00:57:02 by paulb] Added PyGmy example.
     1 Introduction
     2 ------------
     3 
     4 The pprocess module provides elementary support for parallel programming in
     5 Python using a fork-based process creation model in conjunction with a
     6 channel-based communications model implemented using socketpair and poll.
     7 
     8 Quick Start
     9 -----------
    10 
    11 Try running some of the tests:
    12 
    13 PYTHONPATH=. python tests/create_loop.py
    14 PYTHONPATH=. python tests/start_loop.py
    15 
    16 (Simple loop demonstrations which use two different ways of creating and
    17 starting the parallel processes.)
    18 
    19 PYTHONPATH=. python tests/start_indexer.py <directory>
    20 
    21 (A text indexing demonstration, where <directory> should be a directory
    22 containing text files to be indexed, although HTML files will also work well
    23 enough. After indexing the files, a prompt will appear, words or word
    24 fragments can be entered, and matching words and their locations will be
    25 shown. Run the program without arguments to see more information.)
    26 
    27 Some examples are also found in the examples directory, notably the PyGmy
    28 raytracer modified to use pprocess:
    29 
    30 cd examples/PyGmy
    31 PYTHONPATH=../..:. python scene.py
    32 
    33 Contact, Copyright and Licence Information
    34 ------------------------------------------
    35 
    36 No Web page has yet been made available for this work, but the author can be
    37 contacted at the following e-mail address:
    38 
    39 paul@boddie.org.uk
    40 
    41 Copyright and licence information can be found in the docs directory - see
    42 docs/COPYING.txt and docs/LICENCE.txt for more information.
    43 
    44 For the PyGmy raytracer example, different copyright and licence information
    45 is provided in the docs directory - see docs/COPYING-PyGmy.txt and
    46 docs/LICENCE-PyGmy.txt for more information.
    47 
    48 Dependencies
    49 ------------
    50 
    51 This software depends on standard library features which are stated as being
    52 available only on "UNIX"; it has only been tested on a GNU/Linux system.
    53 
    54 New in parallel 0.2.1 (Changes since parallel 0.2)
    55 --------------------------------------------------
    56 
    57   * Added a PyGmy raytracer example.
    58 
    59 New in parallel 0.2 (Changes since parallel 0.1)
    60 ------------------------------------------------
    61 
    62   * Changed the name of the included module from parallel to pprocess in order
    63     to avoid naming conflicts with PyParallel.
    64 
    65 Release Procedures
    66 ------------------
    67 
    68 Update the pprocess __version__ attribute.
    69 Change the version number and package filename/directory in the documentation.
    70 Update the release notes (see above).
    71 Check the release information in the PKG-INFO file.
    72 Tag, export.
    73 Archive, upload.
    74 Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
    75 
    76 Making Packages
    77 ---------------
    78 
    79 To make Debian-based packages:
    80 
    81   1. Create new package directories under packages if necessary.
    82   2. Make a symbolic link in the distribution's root directory to keep the
    83      Debian tools happy:
    84 
    85      ln -s packages/ubuntu-hoary/python2.4-parallel-pprocess/debian/
    86 
    87   3. Run the package builder:
    88 
    89      dpkg-buildpackage -rfakeroot
    90 
    91   4. Locate and tidy up the packages in the parent directory of the
    92      distribution's root directory.