Skip to content

Commit

Permalink
Merge branch 'release/0.0.8'
Browse files Browse the repository at this point in the history
  • Loading branch information
wmayner committed May 19, 2014
2 parents 3868362 + c99c38f commit 091485c
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 7,244 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ build
*.pyc
dist
pyemd.egg-info
*.cpp
10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
language: python
python:
- "3.2"
- "3.3"
# Install dependencies
install:
- python setup.py install
- pip install pytest
# Run tests
script: py.test
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
buildcython:
cython -v -t --cplus pyemd/emd.pyx
python setup.py build_ext --inplace
mv emd.so pyemd
mv emd.cpython-34m.so pyemd/emd.so

clean:
rm -rf pyemd/emd.so
Expand Down
12 changes: 10 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
**************************
PyEMD: Fast EMD for Python
**************************
.. image:: https://travis-ci.org/wmayner/pyemd.svg?branch=develop
:target: https://travis-ci.org/wmayner/pyemd

PyEMD is a Python wrapper for `Ofir Pele and Michael Werman's implementation
<http://www.seas.upenn.edu/~ofirpele/FastEMD/code/>`_ of the `Earth Mover's
Expand All @@ -17,18 +19,22 @@ Installation

To install the latest release:

.. code:: bash
pip install pyemd
To install the latest development version:

.. code:: bash
pip install "git+https://github.com/wmayner/pyemd@develop#egg=pyemd"
Usage
~~~~~

Use PyEMD like so:

.. code-block:: python
.. code:: python
>>> from pyemd import emd
>>> import numpy as np
Expand All @@ -41,7 +47,7 @@ Use PyEMD like so:
API
~~~

.. code-block:: python
.. code:: python
emd(first_signature, second_signature, distance_matrix)
Expand All @@ -65,6 +71,8 @@ Limitations and Caveats
- The original C++ functions have optional parameters ``extra_mass_penalty``
and ``F`` (for flows); this wrapper does not expose those parameters. See
the documentation in **pyemd/lib/emd_hat.hpp**.
- You may get segfaults if you pass bad arguments. Input is not validated, for
a (probably negligible) speed boost!


Contributing
Expand Down
2 changes: 1 addition & 1 deletion pyemd/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"""

__title__ = 'pyemd'
__version__ = '0.0.7'
__version__ = '0.0.8'
__author__ = 'Will Mayner'
__author_email__ = 'wmayner@gmail.com'
__author_website__ = 'http://willmayner.com'
Expand Down

0 comments on commit 091485c

Please sign in to comment.