From 1c6a0f8f60bd48ae26b4238867e9e1e1a8e2671b Mon Sep 17 00:00:00 2001
From: Munyoki Kilyungi
Date: Mon, 14 Jul 2025 16:49:14 +0300
Subject: Add module doc-string.

Signed-off-by: Munyoki Kilyungi <me@bonfacemunyoki.com>
---
 scripts/lmdb_matrix.py | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'scripts/lmdb_matrix.py')

diff --git a/scripts/lmdb_matrix.py b/scripts/lmdb_matrix.py
index 451976b..79d3197 100644
--- a/scripts/lmdb_matrix.py
+++ b/scripts/lmdb_matrix.py
@@ -1,3 +1,17 @@
+"""This scripts reads and store genotype files to an LMDB store.
+Similarly, it can be use to read this data.
+
+Example:
+
+guix shell python-click python-lmdb python-wrapper python-numpy -- \
+     python lmdb_matrix.py import-genotype \
+     <path-to-genotype-file> <path-to-lmdb-store>
+
+guix shell python-click python-lmdb python-wrapper python-numpy -- \
+     python lmdb_matrix.py print-current-matrix \
+     <path-to-lmdb-store>
+
+"""
 import os
 import lmdb
 import json
-- 
cgit 1.4.1