about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorPjotr <wrk@bosa.lan>2026-11-07 16:38:01 +0000
committerPjotr <wrk@bosa.lan>2026-11-07 16:38:01 +0000
commiteb84a85a2e306e4e237b84e64ea89ba708d2405d (patch)
treec97e4128d806403b77aa3b4c717dcf8e3f529bb9 /docs
parent3babef5d4596d94f3d6d200e4b7bd9815d288b9f (diff)
downloadgenenetwork4-eb84a85a2e306e4e237b84e64ea89ba708d2405d.tar.gz
docs: a new genotype file needs no restart; only code and env do
Paths travel in the request and no panel is cached in-process; both
engines key their caches on file contents (rqtl hashes the genotype file
into the output name, gemma-wrapper hashes into its kinship cache), so a
changed file is recomputed rather than silently reused.

The restart list is the useful half: new binary, GENENETWORK4_TEST_TOKEN
(decided when the router is built), and the environment fixed at first
use -- PATH/R_LIBS_SITE for R, SQL_URI's pool, the Xapian handle -- while
edits to scripts/rqtl_wrapper.R take effect immediately, since it runs
per request.

* docs/genotypes.md: "No restart is needed to use a new genotype file".
Diffstat (limited to 'docs')
-rw-r--r--docs/genotypes.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/genotypes.md b/docs/genotypes.md
index ce829fc..01b4962 100644
--- a/docs/genotypes.md
+++ b/docs/genotypes.md
@@ -157,6 +157,27 @@ subset. When the API takes over the alignment, it should subset to the
 strains by default and offer "include parents and F1s" explicitly, which
 is what GN2's checkbox does.
 
+## No restart is needed to use a new genotype file
+
+The path travels in each request and nothing in the server caches a
+panel, so pointing a request at a newer file (`BXD.8.geno` instead of
+`BXD.geno`, `HET3-ITP.12.geno` instead of `.11`) takes effect on the next
+request. Both engines' result caches key on file **contents**, not paths:
+`src/rqtl.rs` reads the genotype file and hashes it into the output
+filename, and gemma-wrapper names its cached kinship by a content hash --
+so a file that has changed is recomputed, not silently reused.
+
+What does need a restart:
+
+- a new binary (any Rust change), and `GENENETWORK4_TEST_TOKEN`, which is
+  decided when the router is built;
+- the process environment: `PATH` and `R_LIBS_SITE` (R/qtl's `Rscript`
+  and its `qtl`/`optparse`/`stringi`/`stringr` packages), and the values
+  the process fixes at first use -- `SQL_URI` (the MySQL pool),
+  `XAPIAN_DB_PATH`/`SEARCH_ENGINE` (the open index handle);
+- not `scripts/rqtl_wrapper.R`: it runs as a subprocess per request, so
+  editing it takes effect immediately.
+
 ## What is still messy
 
 `HET3-ITP` has eleven `.geno` versions on disk (`.2` … `.12`) and **no