You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Include pre-built documentation with distribution and improve error messaging
when Tkinter is not available. Simplify download page and recommend pipx.
This is now the tagged release for v1.6.2 however no changes to the Python
or Windows distributions has been made, the only difference is for the
source distribution here on Github and in the releases branch.
DVR-Scan requires Python 3.8 or higher to run, and works on Windows, Linux, and OSX. [`pipx` is recommended](https://pipx.pypa.io/stable/installation/) for installing DVR-Scan, however installing via `pip` or from source is also supported.
22
25
23
-
DVR-Scan works on Windows, Linux, and OSX, and requires Python 3.8 or higher. Linux users may need to install the `python3-tk` package (e.g. `sudo apt-get install python3-tk`) to run the region editor.
26
+
Linuxusers may need to install the `python3-tk` package (e.g. `sudo apt install python3-tk`) to run the region editor.
24
27
25
28
-------------------------------
26
29
@@ -33,22 +36,28 @@ DVR-Scan works on Windows, Linux, and OSX, and requires Python 3.8 or higher. Li
33
36
34
37
The installer is recommended for most users. Windows builds include all required dependencies to run DVR-Scan. Only 64-bit builds are available.
35
38
39
+
-------------------------------
40
+
41
+
## Servers and Headless Systems
42
+
43
+
For installation on servers and other headless systems that do not require a GUI, install `dvr-scan[opencv-headless]` instead of `dvr-scan[opencv]`. This will make sure that [the headless version of OpenCV](https://pypi.org/project/opencv-python-headless/) is installed, which avoids any dependencies on X11 libraries or any other GUI components. This allows DVR-Scan to run with less dependencies, and can result in smaller Docker images.
36
44
37
45
-------------------------------
38
46
47
+
## Source
39
48
40
-
<h3>CUDA®-Enabled Builds (Experimental)</h3>
49
+
The source code for [DVR-Scan is available on Github](https://github.com/Breakthrough/DVR-Scan). It can be run directly from source (`python -m dvr_scan`), or built locally (`python -m build`).
41
50
42
-
GPU support currently requires a development environment setup including the Nvidia CUDA® SDK.
51
+
-------------------------------
43
52
44
-
DVR-Scan works with CUDA graphics cards if you are using the Python distribution, and you have a CUDA-enabled verison of the `opencv-python` package. Unfortunately pre-built binaries are not available, so this requires that you build from source (there are various tutorials online for how to do this).
45
53
46
-
When available, you should see `cv2.cuda: Installed` under the features list when running `dvr-scan --version`. Make sure to set `-b MOG2_CUDA` when running DVR-Scan (e.g. `dvr-scan -i video.mp4 -b MOG2_CUDA`).
54
+
## CUDA®-Enabled Builds
47
55
56
+
GPU support currently requires a development environment setup including the Nvidia CUDA® SDK.
48
57
49
-
## Source
58
+
DVR-Scan works with CUDA graphics cards if you are using the Python distribution, and you have a CUDA-enabled verison of the `opencv-python` package. Unfortunately pre-built binaries are not available, so this requires that you build from source (there are various tutorials online for how to do this).
50
59
51
-
The source code for [DVR-Scan is available on Github](https://github.com/Breakthrough/DVR-Scan). It can be run directly from source (`python -m dvr_scan`), or built locally (`python -m build`).
60
+
When available, you should see `cv2.cuda: Installed` under the features list when running `dvr-scan --version`. Make sure to set `-b MOG2_CUDA` when running DVR-Scan (e.g. `dvr-scan -i video.mp4 -b MOG2_CUDA`).
0 commit comments