about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorPjotr <wrk@bosa.lan>2026-11-11 13:21:05 +0000
committerPjotr <wrk@bosa.lan>2026-11-11 13:21:05 +0000
commitca7efa231bbd818b5166e38b59e3c81ea30821b3 (patch)
treeca02a03ebbf576afc1ea45ff3e251bd1c967056b /docs
parentf4d2d719f90774e85bc47eca041bc469f0f0951d (diff)
downloadgenenetwork4-ca7efa231bbd818b5166e38b59e3c81ea30821b3.tar.gz
bulklmm: BULKLMM_BLOCKS as a config option, default 4
The marker blocks a single-trait scan is split into were the driver's
default (Threads.nthreads()) and changed with --threads. They are a
separate knob now:

  BULKLMM_THREADS   Julia threads (--threads)               default 4
  BULKLMM_BLOCKS    independent marker blocks, scanned       default 4
                    in parallel (1 = serial scan)

Blocks are exact either way -- LOD 9.589938 and the same permutation
thresholds at 1 and 4 -- so the knob only buys wall clock. The reply says
what ran ("split into 4 independent blocks and scanned on 4 Julia
thread(s) (BULKLMM_BLOCKS / BULKLMM_THREADS ...)"), because the answer to
"is it multicore?" should be in the response and not in the log.
Diffstat (limited to 'docs')
-rw-r--r--docs/bulklmm.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/bulklmm.md b/docs/bulklmm.md
index 8a39798..86b08dd 100644
--- a/docs/bulklmm.md
+++ b/docs/bulklmm.md
@@ -74,7 +74,7 @@ OpenBLAS defaults to every core on the machine (96 here) and oversubscribes on
 matrices of this shape. `scripts/bulklmm_scan.jl` therefore:
 
 * **splits the markers into independent blocks** and scans them on Julia
-  threads (`--blocks`, default `BULKLMM_THREADS`). It is *exact*: each marker's
+  threads (`--blocks`, `BULKLMM_BLOCKS`, default 4; `1` is a plain serial scan). It is *exact*: each marker's
   LOD is independent once the null variance components are fixed, and those
   depend on `y` and `K` only. Verified identical output — LOD 9.589938 and the
   same thresholds at 1 and 4 blocks — and the permutation thresholds are
@@ -100,7 +100,8 @@ is the shape an eQTL endpoint wants and the next thing to add here.
 | `BULKLMM_ENV` | the project its packages are instantiated into |
 | `BULKLMM_DEPOT` | the depot those packages live in (default `$HOME/.julia`) |
 | `BULKLMM_SCRIPT` | `scripts/bulklmm_scan.jl` |
-| `BULKLMM_THREADS` | July threads / marker blocks (default 4) |
+| `BULKLMM_THREADS` | Julia threads (`--threads`), default **4** |
+| `BULKLMM_BLOCKS` | independent marker blocks scanned in parallel, default **4** (`1` = serial scan, same answer) |
 | `BULKLMM_CACHE_DIR` | scratch: prepared genotypes, cached matrix and kinship |
 | `BULKLMM_PLOTTER` | `scripts/plot-bulklmm.py` for `POST /plot/bulklmm` |