test images? test video? about trackpy HOT 8 CLOSED

We're still working out best way to include example data for users. The file sizes are large, and we don't want to end up with a ~100 MB package. Of course this is balanced by the need to make it easy for users to get started...we'll find a better compromise.

When I wrote the walkthrough, I intended users to try it on their own PNGs (though I see that I didn't make that clear at all).

To get everything, including the tests and test images/video, do a manual installation.

git clone https://github.com/soft-matter/trackpy

(or, to avoid git, download and unpack the ZIP file)

cd trackpy
python setup.py install

Later, if you want to be able to edit the scripts and have those changes applied without running python setup.py install every time, you can install it "in place" instead:

python setup.py develop

from trackpy.

Just got your email. Sending an image now...

from trackpy.

Thanks. Yeah, it is not clear that images are not provided. I was trying it on my own images and not finding anything... so I wanted to troubleshoot whether it was my images or my use of the code that was going wrong. With your image, I find particles! ... a different number of them than you do, but particles nonetheless. I would recommend at least including a 100x100 pixel single image just to get people started.

from trackpy.

Hi Becca! As you've probably noticed, we created soft-matter/trackpy-examples and put PNGs of the example movie there. So when someone downloads that repo and runs the example notebook, they have everything they need to reproduce it. Or they can go in and grab a single PNG. It's referenced in the trackpy readme. Does this resolve the issue (for now, at least)?

from trackpy.

Sounds like a good and complete solution, I'll look at it today to test it from an outside perspective and let you know how it goes.

from trackpy.

Yes-- the issue is resolved. More details of my experience checking it:

Here is how I checked the examples, and how a new user might experience it: trackpy-->examples-->found readme --> cloned new repository for trackpy-examples --> %matplotlib magic didn't work, needed to upgrade my version of ipython, then needed up upgrade tornado --> then loading-video-frames.ipynb worked brilliantly. It was so nice not to even have to change the path to the images! To get "imshow" to work in performance.ipynb, I added these lines to the beginning of that notebook on my machine:

%matplotlib inline
import matplotlib
from matplotlib.pyplot import imshow

from trackpy.

Thanks for checking this out, and for the fix! I'll try to get in a PR soon so we can really close this issue.

from trackpy.

performance.ipynb problem fixed by soft-matter/trackpy-examples#6

from trackpy.