openbraininstitute / neurodamus / 38226380784

91%

push

github

Let CoreNEURON reports have names and targets holding whitespace (#590)

CoreNEURON reads `report.conf` split on whitespace, so a report whose
name or target holds whitespace shifts every field after it and
CoreNEURON aborts. For a report on the node set `All Rings`, the
ringtest dies with `Unknown string for ReportType: "All"` (SIGABRT).
SONATA allows such names, and the OBI platform's web app names
recordings `Recording 0` by default, so its CoreNEURON simulations fail,
including every LFP one, since LFP needs CoreNEURON.

## Changes
- `report.conf` holds report and target names with whitespace replaced
by `_` (`coreneuron_report_name`). CoreNEURON parses the target name but
never uses it.
- CoreNEURON names each report's file after its report name, so once it
has run, rank 0 renames `<output>/soma_v.h5` back to the SONATA name,
`soma v.h5`. This happens in `_run_coreneuron`, so it covers the
skip-model-build path too.
- On restore, the end-time substitutions use the names as the saved
`report.conf` holds them.
- A config validator refuses two enabled reports that CoreNEURON would
write to the same file, such as `soma v` and `soma_v`.

NEURON runs are unchanged: neurodamus writes their reports itself, under
their SONATA names.

## Tests
- `test_coreneuron_report_names.py` runs the ringtest under CoreNEURON
with reports `soma v` and `lfp report` on the node set `All Rings`.
- It checks that `report.conf` holds `soma_v.h5`, `lfp_report.h5` and
`All_Rings`, and that the run completes. Without the change, the same
run aborts as above.
- The test build has no libsonatareport, so CoreNEURON writes no report
files. Stand-in files named as CoreNEURON names them check that the run
gives them back their SONATA names.
- It also covers the collision refusal, which applies under CoreNEURON
only.
- `test_coreneuron_report_config.py` covers the name helper and a
dump/load round trip of names that held whitespace.

The LFP, save/restore, ring-cell report and report... (continued)

30 of 32 new or added lines in 3 files covered. (93.75%)

8005 of 8786 relevant lines covered (91.11%)

6.24 hits per line