diff options
| author | Arun Isaac | 2025-08-04 14:48:27 +0100 |
|---|---|---|
| committer | Arun Isaac | 2025-08-06 22:40:42 +0100 |
| commit | bc046a25f1531386293a470e21b569f8411f2235 (patch) | |
| tree | 0b28824677dc7240d7290ae494827014a1ff3f67 /doc | |
| parent | 925bb7d67bcd7e5b756987093b15d21426852ba1 (diff) | |
| download | pyhegp-bc046a25f1531386293a470e21b569f8411f2235.tar.gz pyhegp-bc046a25f1531386293a470e21b569f8411f2235.tar.lz pyhegp-bc046a25f1531386293a470e21b569f8411f2235.zip | |
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.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/file-formats.md | 7 |
1 files changed, 7 insertions, 0 deletions
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.` |