Skip to content

Commit

Permalink
[dist] Ensure python3 -m build works by default
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Breakthrough committed Dec 21, 2024
1 parent c4b898f commit 5cb04a2
Show file tree
Hide file tree
Showing 15 changed files with 5,255 additions and 15 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/update-site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ jobs:
- name: Generate Website
run: |
git rm docs/index_docs.md
mkdocs build -f website/mkdocs.yml
git reset --hard HEAD
- name: Update Website
run: |
Expand Down
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ dist/dvr-scan/*
dist/dvr-scan-*
dist/dvr_scan-*

# Location where docs are built before assembling distributions
dvr_scan/docs/

# Editors/environment
.DS_Store
.vs_code/
Expand Down
31 changes: 20 additions & 11 deletions docs/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,24 @@ hide:


# :fontawesome-solid-download:Download

-------------------------------

## Python <span class="dvr-scan-download-icons">:fontawesome-brands-windows::fontawesome-brands-apple::fontawesome-brands-linux:</span>

!!! python-download "**1.6.2**<span class="dvr-scan-release-date">December 17, 2024</span>"

<h3>Regular Install:</h3>
<h3>pipx (recommended):</h3>

pipx install dvr-scan[opencv]

pip install dvr-scan[opencv]==1.6.2
<h3>pip:</h3>

<h3>Headless (Servers):</h3>
python3 -m pip install dvr-scan[opencv]

pip install dvr-scan[opencv-headless]==1.6.2
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.

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.
Linux users may need to install the `python3-tk` package (e.g. `sudo apt install python3-tk`) to run the region editor.

-------------------------------

Expand All @@ -33,22 +36,28 @@ DVR-Scan works on Windows, Linux, and OSX, and requires Python 3.8 or higher. Li

The installer is recommended for most users. Windows builds include all required dependencies to run DVR-Scan. Only 64-bit builds are available.

-------------------------------

## Servers and Headless Systems

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.

-------------------------------

## Source

<h3>CUDA®-Enabled Builds (Experimental)</h3>
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`).

GPU support currently requires a development environment setup including the Nvidia CUDA® SDK.
-------------------------------

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).

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`).
## CUDA®-Enabled Builds

GPU support currently requires a development environment setup including the Nvidia CUDA® SDK.

## Source
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).

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`).
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`).

-------------------------------

Expand Down
Loading

0 comments on commit 5cb04a2

Please sign in to comment.