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

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

Commit Message

Stefan Klug June 28, 2024, 10:46 a.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
rawpi 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>
---
 utils/tuning/README.rst       | 23 ++++++++++++++++-------
 utils/tuning/requirements.txt |  5 +++++
 2 files changed, 21 insertions(+), 7 deletions(-)
 create mode 100644 utils/tuning/requirements.txt

Comments

Laurent Pinchart June 28, 2024, 10:35 p.m. UTC | #1
Hi Stefan,

Thank you for the patch.

On Fri, Jun 28, 2024 at 12:46:58PM +0200, Stefan Klug wrote:
> 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
> rawpi is not packaged as deb. So pip has to be used anyways.

s/rawpi/rawpy/

Looks like Gentoo doesn't provide a package either :-(

> Also add pyyaml which was missing in the dependencies.
> 
> Signed-off-by: Stefan Klug <stefan.klug@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
> 
> diff --git a/utils/tuning/README.rst b/utils/tuning/README.rst
> index ef3e6ad76f1b..ef6dbe28f676 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

s/Libcamera/libcamera/

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> +======================
>  
> -Dependencies
> -------------
> +.. Note:: The tuning tool 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

Patch
diff mbox series

diff --git a/utils/tuning/README.rst b/utils/tuning/README.rst
index ef3e6ad76f1b..ef6dbe28f676 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 tool 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