Pyfort:  Numerical Python -- Fortran  and Fortran-like C connection tool
Copyright, 1999, 2000, 2001, 2002 Regents of the University of California
Author: Paul F. Dubois, 
Program for Climate Model Diagnosis and Intercomparison
Lawrence Livermore National Laboratory
dubois@users.sourceforge.net
Source Forge Project: sourceforge.net/projects/pyfortran

Please see Legal.htm for precise language about our free release of this
software.

CHANGE HISTORY 

   See changes.txt.

CAUTION -- This software by its nature is dependent on your Fortran compiler 
   and your system. Pyfort may require adjustment before use. 
   Please read the documentation.

REQUIRES NUMPY AND DISTUTILS
   If you are using Python 1.5.2, you'll need to install Distutils first. 
   See below.

   Numerical Python must be installed before use. See numpy.sf.net.

DOCUMENTATION
   http://pyfortran.sourceforge.net.

INSTALLATION

Step 1: If using a pre-1.6 Python, get and install the Distutils from 
    www.python.org/sigs/distutils-sig. If using a separately acquired
    version of distutils on a 1.6.x Python, be aware that the standard 
    distribution already contains distutils in 
        $(PYTHON/lib/python1.6/distutils
    but the Distutils installer puts it in 
        $(PYTHON)/lib/python1.6/site-packages/distutils
    You will therefore end up with two of them. Delete the former.

    If you do not have permission in your Python installation directory 
    follow the instructions below Step 3 to install Pyfort 
    in another location.

Step 2: Configuration. 
    Most people will not need to do anything here.

    You may wish to edit configuration.py to change these variables: 
    
    A. default_fortran_compiler_id (default, platform dependent)
       Choose a non-standard default value for the Fortran compiler for 
       your platform. See the documentation for the names of some popular 
       compilers we support, what to do if the one you want isn't there, 
       and how to help add yours to Pyfort so this won't happen the next time.

    B. prefix (default, '')
       Set a directory name for project installations by setting the variable
       prefix. If blank, the default, Pyfort installs its 
       files into the Python that was used to install Pyfort, in the
       site-packages subdirectory. (E.g. $PYTHON/lib/python2.2/site-packages.)

    C. project_suffix (default, '_dir'; do not set to blank)
       To enable uninstalling, Pyfort installs modules in a container directory.  
       This container directory is named by adding configuration.project_suffix 
       to the name of the project, which is the name of the project file without 
       the ".pfp".  A Python path configuration file (*.pth) is written as a 
       peer of the container directory. 

       If '_dir' will cause a conflict, or you just hate it, you can change 
       it by using project_suffix.

    
Step 3: To install the Pyfort package into your python, just do:

    python setup.py install

Installing outside of Python

    If you do not have write permission inside Python's root directory,
    you will have to install Python and the extensions it creates somewhere
    else.  Edit configuration.py as explained in Step 2B, to set 
    prefix='/somewhere'
    where /somewhere is your desired location. Then install Pyfort using:
    
    python setup.py install --prefix=/somewhere

    You will also need to set the environment variable PYTHONPATH to 
    include the site-packages directory that will be created by this install
    (e.g. /somewhere/lib/python2.2/site-packages) and add /somewhere/bin
    to your execution path. 

    The .pth files unfortunately do not function outside the Python installation.
    For this reason, the container directories mentioned cannot be used 
    in this case, and the -u uninstall command will not work.

USAGE
    Run pyfort with no arguments to get current usage information.


TESTING and EXAMPLES
    The demo directory contains a simple example of using Python code
    with a Fortran extension.

    The test and testc directories contain tests for Fortran and Fortran-like
    C extensions and also serve as examples.

    Each of these can be installed by switching to the directory in question
    and executing 
    
    pyfort -i project-name

    where project-name is the name of the file with the .pfp extension.
    Then execute:
    python test.py

    Later you may wish to remove the files it installed:
    pyfort -u project-name

BUGS
    Functions returning a complex scalar do not work on Sun Solaris Fortran
    and some other platforms. 
   (Complex arrays as outputs are ok; doubtless compiler returns value oddly)

