[v4,05/23] utils: tuning: Add requirements file and update readme
diff mbox series

Message ID 20240705144209.418906-6-stefan.klug@ideasonboard.com
State Accepted
Headers show
Series
  • Add ccm calibration to libtuning
Related show

Commit Message

Stefan Klug July 5, 2024, 2:41 p.m. UTC 
Add a requirements file to ease the installation and use of the tuning
scripts. Document that in the readme. No debian packages are provided as
rawpy is not packaged as deb. So pip has to be used anyways.

Also add pyyaml which was missing in the dependencies.

Signed-off-by: Stefan Klug <stefan.klug@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>
---
 utils/tuning/README.rst       | 23 ++++++++++++++++-------
 utils/tuning/requirements.txt |  5 +++++
 2 files changed, 21 insertions(+), 7 deletions(-)
 create mode 100644 utils/tuning/requirements.txt

Patch
diff mbox series 

diff --git a/utils/tuning/README.rst b/utils/tuning/README.rst
index ef3e6ad76f1b..89a1d61e62a8 100644
--- a/utils/tuning/README.rst
+++ b/utils/tuning/README.rst
@@ -1,11 +1,20 @@ 
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
-.. TODO: Write an overview of libtuning
+libcamera tuning tools
+======================
 
-Dependencies
-------------
+.. Note:: The tuning tools are still very much work in progress. If in doubt,
+    please ask on the mailing list.
+
+.. todo::
+    Write documentation
+
+Installation of dependencies
+----------------------------
+
+::
+    # Using a venv
+    python3 -m venv venv
+    . ./venv/bin/activate
+    pip3 install -r requirements.txt
 
-- numpy
-- opencv-python
-- py3exiv2
-- rawpy
diff --git a/utils/tuning/requirements.txt b/utils/tuning/requirements.txt
new file mode 100644
index 000000000000..d1dc589d0329
--- /dev/null
+++ b/utils/tuning/requirements.txt
@@ -0,0 +1,5 @@ 
+numpy
+opencv-python
+py3exiv2
+pyyaml
+rawpy