From bc046a25f1531386293a470e21b569f8411f2235 Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Mon, 4 Aug 2025 14:48:27 +0100
Subject: Standardize key files.

* doc/file-formats.md (File formats)[key file]: New section.
* pyhegp/serialization.py: Import numpy.
(read_key, write_key): New functions.
* pyhegp/pyhegp.py: Import write_key from pyhegp.serialization.
(encrypt): Use write_key.
* tests/test_serialization.py: Import arrays and array_shapes from
hypothesis.extra.numpy; approx from pytest; read_key and write_key
from pyhegp.serialization.
(test_read_write_key_are_inverses): New test.
---
 doc/file-formats.md | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'doc/file-formats.md')

diff --git a/doc/file-formats.md b/doc/file-formats.md
index be8162f..02df7ef 100644
--- a/doc/file-formats.md
+++ b/doc/file-formats.md
@@ -20,3 +20,10 @@ the `reference` column is optional, and should be absent in encrypted genotype f
 
 Here is an example genotype file.
 `TODO: Add example.`
+
+## key file
+
+The key file is a tab-separated values (TSV) file with numerical data. There MUST be no column headers.
+
+Here is an example key file.
+`TODO: Add example.`
-- 
cgit 1.4.1