These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
You need the following tools for the installation:
- Git >= 1.5.3
- Python >= 3.7
You also need at least the following Python packages:
- Pip >= 1.4
- Setuptools >= 0.8
You also need to install the libxml2, and libxslt libraries, which are required by the lxml Python package. To install the libxml2, and libxslt libraries, follow the instructions in the lxml documentation.
You also need to install the libspatial library, which is required by the Rtree Python package. To install the libspatial library, follow the instructions in the Rtree documentation.
If you are using a platform for which wheel binary packages are not available, you may need to perform extra steps. Consult the documentation of the OpenCV, and Shapely packages for further details.
To install the development version of the package, use Pip:
$ pip install git+https://github.com/video699/implementation-system.git@master
If you wish to use the GPU to accelerate tensor operations in the
video699.event.siamese module, consult the documentation of the
TensorFlow package. Pip
will only install the CPU version of the package by default.
If you wish to run tests, or build the documentation, use Pip to download
additional Python packages specified in the requirements.txt file:
$ pip install -r requirements.txt
Running automated tests is a good way to check that you installed the package correctly, or that your change to the package did not break any functionality covered by the tests. To run automated tests, use the following command:
$ python setup.py test
We use SemVer for versioning. For the versions available, see the tags on this repository.
See also the list of contributors who participated in this project.
This project is licensed under the GNU GPLv3 License – see the LICENSE file for details. Note that the project uses the PyMuPDF library, which is released under AGPLv3. Under clause 13 of the AGPLv3, you must provide access to source code of PyMuPDF if you use video699 in a web service.