Aperiot installation instructions
=================================

Contents

I.   Requirements
II.  Quick installation under Linux/Unix
III. Quick installation under Windows
IV.  Detailed installation under Linux/Unix
V.   Detailed installation under Windows



------------------------------------------------------------------------------    
I. Requirements

  - Python 2.4 or newer (you can download it from http://www.python.org)


------------------------------------------------------------------------------    
II. Quick installation under Linux/Unix

    In the command line, type:
    
      cd <install-dir>
      tar zxvf aperiot-<version>.tar.gz
      python setup.py install

    To run the interpreter, type:
    
      apr


------------------------------------------------------------------------------    
III. Quick installation under Windows

    Execute the file 
    
      aperiot-<version>.win32.exe

------------------------------------------------------------------------------    
IV. Detailed installation under Linux/Unix


  1) Download the file
  
      aperiot-<version>.tar.gz
    
    or
    
      aperiot-<version>.zip
  
    where <version> is the desired version, e.g. aperiot-0.1a3.tar.gz;
    
    from:
  
      http://moncs.cs.mcgill.ca/projects/aperiot


  2) Extract the file in some directory <install-dir>. 
  
    If the archive has the .tar.gz extension, from the command line do:
  
      cd <install-dir>
      tar zxvf aperiot-<version>.tar.gz
    
    This will create a directory called "aperiot-<version>" under the directory named
    <install-dir>.

  3) Execute the setup script: (standard install)
  
      cd <install-dir>/aperiot-<version>
      python setup.py install

    This will install the package in the site-packages directory of your python 
    installation, which usually is
    
      <prefix>/lib/python<python-version>/site-packages
        
    where <prefix> is the standard linux prefix: /usr for system files (if python came with your Linux/Unix system,) and /usr/local for non-system files. For instance a typical installation will be located at:
    
      /usr/local/lib/python2.4/site-packages/aperiot
    
    The scripts executable from the command line will be installed under
    
      <prefix>/bin
      
    so usually they will be located in /usr/local/bin.
    
    The actual installation directories are saved in the install_data.py file.
    
    
    3.1) Alternative install (if you do not have root access)
        
    If you do not have permission to install python packages, you can install it in your home directory as follows:
  
      cd <install-dir>/aperiot-<version>
      python setup.py install --home=~

    This will install the packages under 
    
      ~/lib/python
      
    and the executable scripts under 
    
      ~/bin
      
    If you want to install it in another directory, do:
    
      cd <install-dir>/aperiot-<version>
      python setup.py install --prefix=<target-dir>
    
    This will install the packages under 
    
      <target-dir>/lib/python<python-version>/site-packages
      
    and the executable scripts under
    
      <target-dir>/bin.
    
  4) Setting up the path environment variable
  
    In most cases this step is not necessary, as the directories containing python and its packages are usually automatically included. But if this is not the case you should include the path to the python interpreter (usually /usr/local/bin.) 
    
    On C Shells (like tcsh) you can do this by adding the following line to your .cshrc file (which should be located in your home directory; if it doesn't exist, just create a new file:)
    
      setenv path=/usr/local/bin;$path
    
------------------------------------------------------------------------------    
V.   Detailed installation under Windows

  Under windows the files will always be installed in the site-packages folder of your python installation, 
  
    <python-dir>/Lib/site-packages
  
  and the executable scripts under the Scripts folder of your python installation:
  
    <python-dir>/Scripts
  
  Currently there is no possibility of installing it in a different folder.
------------------------------------------------------------------------------    
