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

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

Commit Message

Stefan Klug July 3, 2024, 2:16 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>
---
 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

Paul Elder July 4, 2024, 9:01 a.m. UTC | #1
On Wed, Jul 03, 2024 at 04:16:54PM +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
> 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>
> ---
>  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..ec05c116c536 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, 

s/are/is/

Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>

> +    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
> -- 
> 2.43.0
>

Patch
diff mbox series

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