Merge pull request #17 from DeepLabCut/check_install

fix check_install

Author: AlexEMG

MANIFEST.in

@@ -0,0 +1 @@
+include dlclive/check_install/*

README.md

@@ -34,9 +34,9 @@ Please see our instruction manual to install on a [Windows or Linux machine](doc
 
 - available on pypi as: `pip install deeplabcut-live`
 
-Note, you can test your installation by running:
+Note, you can then test your installation by running:
 
-`python /check_install/check_install.py`
+`dlc-live-test`
 
 If installed properly, this script will i) create a temporary folder ii) download the full_dog model from the [DeepLabCut Model Zoo](http://www.mousemotorlab.org/dlc-modelzoo), iii) download a short video clip of a dog, and iv) run inference while displaying keypoints. v) remove the temporary folder.
 
@@ -112,7 +112,7 @@ dlclive.benchmark_videos('/path/to/exported/model', '/path/to/video', resize=[1.
 dlc-live-benchmark /path/to/exported/model /path/to/video -r 0.5 --pcutoff 0.5 --display-radius 4 --cmap bmy --save-poses --save-video
 ```
 
-### Citation:
+### Reference:
 
 If you utilize our tool, please cite our [paper](https://www.biorxiv.org/content/10.1101/2020.08.04.236422v1):
 

check_install/check_install.py dlclive/check_install/check_install.pycheck_install/check_install.py renamed to dlclive/check_install/check_install.py

@@ -9,6 +9,7 @@
 import os
 import shutil
 from dlclive import benchmark_videos
+import urllib.request
 
 
 def main():
@@ -20,21 +21,20 @@ def main():
     os.makedirs(tmp_dir, exist_ok=True)
     os.chdir(tmp_dir)
 
+    # download dog test video from github:
+    url_link = 'https://github.com/DeepLabCut/DeepLabCut-live/blob/master/check_install/dog_clip.avi?raw=True'
+    urllib.request.urlretrieve(url_link,"dog_clip.avi")
+    video_file=os.path.join(url_link,"dog_clip.avi")
+    
     # download exported dog model from DeepLabCut Model Zoo
     print("Downloading full_dog model from the DeepLabCut Model Zoo...")
     model_url = "http://deeplabcut.rowland.harvard.edu/models/DLC_Dog_resnet_50_iteration-0_shuffle-0.tar.gz"
     os.system(f"curl {model_url} | tar xvz")
 
-    # download dog video clip from github
-    print("\nDownloading dog video clip...\n")
-    # video_url = "https://github.com/DeepLabCut/DeepLabCut-live/raw/master/check_install/dog_clip.avi"
-    video_url = '"https://docs.google.com/uc?export=download&id=1W_5AOl1SewXR2q5QC1K5Chm71I9LAmld"'
-    os.system(f"curl -L {video_url} -o dog_clip.avi")
-
     # run benchmark videos
     print("\n Running inference...\n")
     model_dir = "DLC_Dog_resnet_50_iteration-0_shuffle-0"
-    video_file = "dog_clip.avi"
+    print(video_file)
     benchmark_videos(model_dir, video_file, display=True, resize=0.5, pcutoff=0.25)
 
     # deleting temporary files

dlclive/version.py

@@ -7,5 +7,5 @@
 """
 
 
-__version__ = "0.0.1"
+__version__ = "0.0.2"
 VERSION = __version__

docs/install_desktop.md

@@ -20,8 +20,8 @@ pip install deeplabcut-live
 dlc-live-test
 ```
 
-Note, you can test your installation by running:
+Note, you can also just run the test:
 
-`python /check_install/check_install.py`
+`dlc-live-test`
 
 If installed properly, this script will i) create a temporary folder ii) download the full_dog model from the [DeepLabCut Model Zoo](http://www.mousemotorlab.org/dlc-modelzoo), iii) download a short video clip of a dog, and iv) run inference while displaying keypoints. v) remove the temporary folder.

docs/install_jetson.md

@@ -26,7 +26,8 @@ sudo apt-get install libhdf5-serial-dev \
                      gfortran \
                      python3-pip \
                      python3-venv \
-                     python3-tk
+                     python3-tk \
+                     curl
 ```
 
 #### Create a virtual environment

reinstall.sh

@@ -1,3 +1,3 @@
 pip uninstall deeplabcut-live
 python3 setup.py sdist bdist_wheel
-pip install dist/deeplabcut_live-0.0.1-py3-none-any.whl
+pip install dist/deeplabcut_live-0.0.2-py3-none-any.whl

setup.py

@@ -37,7 +37,7 @@
 
 setuptools.setup(
     name="deeplabcut-live",
-    version="0.0.1",
+    version="0.0.2",
     author="A. & M. Mathis Labs",
     author_email="[email protected]",
     description="Class to load exported DeepLabCut networks and perform pose estimation on single frames (from a camera feed)",
@@ -47,6 +47,7 @@
     python_requires=">=3.5, <3.8",
     install_requires=install_requires,
     packages=setuptools.find_packages(),
+    package_data={'dlclive': ['check_install/*']},
     include_package_data=True,
     classifiers=(
         "Programming Language :: Python :: 3",
@@ -55,7 +56,7 @@
     ),
     entry_points={
         "console_scripts": [
-            "dlc-live-test=check_install.check_install:main",
+            "dlc-live-test=dlclive.check_install.check_install:main",
             "dlc-live-bench=dlclive.bench:main",
             "dlc-live-benchmark=dlclive.benchmark:main",
         ]