Add check install script (#13)

* add check install script

* requirements: remove pandas and tables

* Update install_desktop.md

Author: gkane26

check_install/check_install.py

@@ -0,0 +1,48 @@
+"""
+DeepLabCut Toolbox (deeplabcut.org)
+© A. & M. Mathis Labs
+
+Licensed under GNU Lesser General Public License v3.0
+"""
+
+
+import os
+import shutil
+from dlclive import benchmark_videos
+
+
+def main():
+
+    # make temporary directory in $HOME
+    print("\nCreating temporary directory...\n")
+    home = os.path.expanduser("~")
+    tmp_dir = os.path.normpath(f"{home}/dlc-live-tmp")
+    os.makedirs(tmp_dir, exist_ok=True)
+    os.chdir(tmp_dir)
+
+    # 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"
+    benchmark_videos(model_dir, video_file, display=True, resize=0.5, pcutoff=0.25)
+
+    # deleting temporary files
+    print("\n Deleting temporary files...\n")
+    shutil.rmtree(tmp_dir)
+
+    print("\nDone!\n")
+
+
+if __name__ == "__main__":
+    main()

check_install/dog_clip.avi

@@ -1,22 +1,23 @@
 ### Install DeepLabCut-live on a desktop (Windows/Ubuntu)
 
-We recommend that you install DeepLabCut-live in a conda environment. First, please install Anaconda:
+We recommend that you install DeepLabCut-live in a conda environment (It is a standard python package though, and other distributions will also likely work). In this case, please install Anaconda:
+
 - [Windows](https://docs.anaconda.com/anaconda/install/windows/)
 - [Linux](https://docs.anaconda.com/anaconda/install/linux/)
 
 Create a conda environment with python 3.7 and tensorflow:
+
 ```
 conda create -n dlc-live python=3.7 tensorflow-gpu==1.13.1 # if using GPU
 conda create -n dlc-live python=3.7 tensorflow==1.13.1 # if not using GPU
 ```
 
-Activate the conda environment and install the DeepLabCut-live package:
+Activate the conda environment, install the DeepLabCut-live package, then test the installation:
+
 ```
 conda activate dlc-live
 pip install deeplabcut-live
+dlc-live-test
 ```
 
-We also recommend that you have OpenCV installed:
-```
-pip install opencv-python
-```
+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_desktop.md

@@ -1,15 +1,18 @@
 ### Install DeepLabCut-live on a NVIDIA Jetson Development Kit
 
 First, please follow NVIDIA's specific instructions to setup your Jetson Development Kit (see [Jetson Development Kit User Guides](https://developer.nvidia.com/embedded/learn/getting-started-jetson)). Once you have installed the NVIDIA Jetpack on your Jetson Development Kit, make sure all system libraries are up-to-date. In a terminal, run:
+
 ```
 sudo apt-get update
 sudo apt-get upgrade
 ```
+
 Lastly, please test that CUDA is installed properly by running: `nvcc --version`. The output should say the version of CUDA installed on your Jetson.
 
 #### Install python, virtualenv, and tensorflow
 
 We highly recommend installing DeepLabCut-live in a virtual environment. Please run the following command to install system dependencies needed to run python, to create virtual environments, and to run tensorflow:
+
 ```
 sudo apt-get update
 sudo apt-get install libhdf5-serial-dev \
@@ -29,6 +32,7 @@ sudo apt-get install libhdf5-serial-dev \
 #### Create a virtual environment
 
 Next, create a virtual environment called `dlc-live`, activate the `dlc-live` environment, and update it's package manger:
+
 ```
 python3 -m venv dlc-live
 source dlc-live/bin/activate
@@ -37,7 +41,8 @@ pip install -U pip testresources setuptools
 
 #### Install DeepLabCut-live dependencies
 
-First, install python dependencies to run tensorflow (from [NVIDIA instructions to install tensorflow on Jetson platforms](https://docs.nvidia.com/deeplearning/frameworks/install-tf-jetson-platform/index.html)). *This may take ~15-30 minutes.*
+First, install python dependencies to run tensorflow (from [NVIDIA instructions to install tensorflow on Jetson platforms](https://docs.nvidia.com/deeplearning/frameworks/install-tf-jetson-platform/index.html)). _This may take ~15-30 minutes._
+
 ```
 pip3 install numpy==1.16.1 \
              future==0.17.1 \
@@ -51,24 +56,25 @@ pip3 install numpy==1.16.1 \
              pybind11
 ```
 
-Next, install tensorflow 1.x. This command will depend on the version of Jetpack you are using. If you are uncertain, please refer to [NVIDIA's instructions](https://docs.nvidia.com/deeplearning/frameworks/install-tf-jetson-platform/index.html#install). To install tensorflow 1.x on the latest version of NVIDIA Jetpack (version 4.4 as of 8/2/2020), please the command below. *This step will also take 15-30 mins*.
+Next, install tensorflow 1.x. This command will depend on the version of Jetpack you are using. If you are uncertain, please refer to [NVIDIA's instructions](https://docs.nvidia.com/deeplearning/frameworks/install-tf-jetson-platform/index.html#install). To install tensorflow 1.x on the latest version of NVIDIA Jetpack (version 4.4 as of 8/2/2020), please the command below. _This step will also take 15-30 mins_.
+
 ```
 pip3 install --pre --extra-index-url https://developer.download.nvidia.com/compute/redist/jp/v44 ‘tensorflow<2’
 ```
 
 Lastly, copy the opencv-python bindings into your virtual environment:
+
 ```
 cp -r /usr/lib/python3.6/dist-packages ~/dlc-live/lib/python3.6/dist-packages
 ```
 
 #### Install the DeepLabCut-live package
 
-Finally, please install DeepLabCut-live from PyPi (*this will take 3-5 mins):
+Finally, please install DeepLabCut-live from PyPi (_this will take 3-5 mins_), then test the installation:
+
 ```
 pip install deeplabcut-live
+dlc-live-test
 ```
 
-
-
-
-
+If installed properly, this script will i) download the full_dog model from the DeepLabCut Model Zoo, ii) download a short video clip of a dog, and iii) run inference while displaying keypoints.

docs/install_jetson.md

@@ -4,5 +4,3 @@ colorcet
 pillow
 py-cpuinfo==5.0.0
 tqdm
-tables
-pandas

requirements.txt

@@ -16,19 +16,30 @@
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
-install_requires = ['numpy', 'ruamel.yaml', 'colorcet', 'pillow', 'py-cpuinfo==5.0.0', 'tqdm']
+install_requires = [
+    "numpy",
+    "ruamel.yaml",
+    "colorcet",
+    "pillow",
+    "py-cpuinfo==5.0.0",
+    "tqdm",
+]
 
-if find_spec('cv2') is None:
-    install_requires.append('opencv-python')
-if (find_spec('tensorflow') is None):
-    warnings.warn("tensorflow is not yet installed. Installing tensorflow CPU version. if you wish to use the GPU version, please run: pip install tensorflow-gpu==1.13.1")
-    install_requires.append('tensorflow==1.13.1')
-if 'tegra' in platform.platform():
-    if (find_spec('pandas') is None):
-        warnings.warn("Not installing pandas or pytables (these can take forever on NVIDIA Jetson boards). Please install these packages if you want to use the benchmark_videos function to save poses from a video.")
+if find_spec("cv2") is None:
+    install_requires.append("opencv-python")
+if find_spec("tensorflow") is None:
+    warnings.warn(
+        "tensorflow is not yet installed. Installing tensorflow CPU version. if you wish to use the GPU version, please run: pip install tensorflow-gpu==1.13.1"
+    )
+    install_requires.append("tensorflow==1.13.1")
+if "tegra" in platform.platform():
+    if find_spec("pandas") is None:
+        warnings.warn(
+            "Not installing pandas or pytables (these can take forever on NVIDIA Jetson boards). Please install these packages if you want to use the benchmark_videos function to save poses from a video."
+        )
 else:
-    install_requires.append('pandas')
-    install_requires.append('tables')
+    install_requires.append("pandas")
+    install_requires.append("tables")
 
 setuptools.setup(
     name="deeplabcut-live",
@@ -39,7 +50,7 @@
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/DeepLabCut/DeepLabCut-live",
-    python_requires = '>=3.5, <3.8',
+    python_requires=">=3.5, <3.8",
     install_requires=install_requires,
     packages=setuptools.find_packages(),
     include_package_data=True,
@@ -48,6 +59,11 @@
         "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
         "Operating System :: OS Independent",
     ),
-    entry_points = {'console_scripts' : ['dlc-live-bench=dlclive.bench:main',
-                                         'dlc-live-benchmark=dlclive.benchmark:main']}
+    entry_points={
+        "console_scripts": [
+            "dlc-live-test=check_install.check_install:main",
+            "dlc-live-bench=dlclive.bench:main",
+            "dlc-live-benchmark=dlclive.benchmark:main",
+        ]
+    },
 )