Metadata-Version: 2.1
Name: pyprofit
Version: 1.8.2
Summary: Libprofit wrapper for Python
Home-page: https://github.com/ICRAR/pyprofit
Author: Rodrigo Tobar
Author-email: rtobar@icrar.org
License: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering :: Astronomy
Description-Content-Type: text/x-rst

pyprofit
########

.. image:: https://travis-ci.org/ICRAR/pyprofit.svg?branch=master
    :target: https://travis-ci.org/ICRAR/pyprofit

.. image:: https://img.shields.io/pypi/v/pyprofit.svg
    :target: https://pypi.python.org/pypi/pyprofit

.. image:: https://img.shields.io/pypi/pyversions/pyprofit.svg
    :target: https://pypi.python.org/pypi/pyprofit

*pyprofit* is a python wrapper for `libprofit <https://www.github.com/ICRAR/libprofit>`_.

Installing
==========

*pyprofit* is available in `PyPI <https://pypi.python.org/pypi/pyprofit>`_
and thus can be easily installed via::

 pip install pyprofit

Since version 1.8.1 pre-compiled binary versions of the package
are available for Linux distributions.
These are offered for convenience
and come with OpenMP and FFTW support,
but lack features that some users may want to use,
like OpenCL, threaded-FFTW
and some CPU-specific optimizations.

If you need to *compile* this package
(either because a binary is not available in your platform,
or because you want to get the last drop of performance)
you will need to compile and install *libprofit* first.
For instruction on how to compile and install *libprofit* please read
`libprofit's documentation <http://libprofit.readthedocs.io/en/latest/getting.html#compiling>`_.

If you need to point to a specific libprofit installation
set the ``LIBPROFIT_HOME`` environment variable to point to it,
e.g.::

 LIBPROFIT_HOME=/opt/software/libprofit/1.8.0/ pip install pyprofit

Troubleshooting
---------------

If you are experiencing problems with your installation
(specially if you are compiling this package)
try the following::

 DISTUTILS_DEBUG=1 PYPROFIT_NO_MUTE=1 python setup.py -v build


