= Introduction =

  >>> from py_interpos import interpos      # imports only the interpos function
  >>> yout,youtp,youtpp,youtint = interpos(xin,yin,xout,taus,nbc,ybc,sigmain)

= Requirements =

The fortran source file 'interpos.f90' must be assembled using the command
  $ make interpos_for_python
in the interpos_libs directory

This package requires the python package numpy which includes the f2py package.

= Installation =

To build and install the interpos python module :
  $ python setup.py install

If this command fails try to change the fortran compiler, for example
  $ python setup.py build --fcompiler=intelem
  $ python setup.py install

If you do not have administrative rights on the system, you can try for example
  $ python setup.py install --user

For a more complete overview of the different install possibilities, run
  $ python setup.py install --help

= Documentation =

  Concerning the capabilities of the interpos function please refer to the built-in documentation of the function.
  Concerning the implementation of the python module please refer to the built-in documentation of the module.

= Contents =

The package contains the following files
  __init__.py      : python function definition
  (interpos.f90)   : contains the actual fortran code (generated by Makefile, see the Requirements section)
  interpos_fun.pyf : contains all interface blocks for (relevant) interpos routines, used by f2py
  README.txt       : this file
  setup.py         : setup script for python distribution
  setup.cfg        : configuration file for python setup
  test_interpos.py : simple test case (periodic and standard boundary conditions)