openbraininstitute / neurodamus / 17469037236

90%

Build Type

push

github

Committed by web-flow

Commit Message

coreneuron: test reports (mostly compartment and summation) (#337)

## Context

This should finally take care of the compartment sets for coreneuron

Fix: #345 #322

testing for:

https://github.com/neuronsimulator/nrn/pull/3507
https://github.com/neuronsimulator/nrn/pull/3542

## Scope

- [x] rework report handling (mostly in node and target_manager this time. i.e. removal of `_report_setup`)
- [x] new `CoreReportConfig` to finally handle in a proper way `report.conf`
- [x] remove `write_sim_config`, `update_report_conf`, `write_report_conf` and similar functions in `CoreConfig`. Use `CoreSimulationConfig` and `CoreReportConfig` instead
- [x] move `cell-permute` in another issue/pr. EDIT done: #367
- [x] scaling moved to `report_parameters.py`
- [x] `CumulativeError` moved in `pyutils`
- [x] `ReportParams` now has its own file alleviating the burden of the `node.py` file. `_report_build_params` (previously in `node.py`) is also inside the new file.
- [x] `target_type` is no more. We do not need encoding/decoding. We just write `sections` and `compartments` in the `report.conf` 
- [x] streamlined `enable_reports`. It is still a complex function but it should be easier to read and with less edge cases 
- [x] use the decorator `@cache_errors` to just fill a `CumulativeError` instead of raising an error and raise it at the end
- [x] `merge_dicts` (in `tests/utils.py`) allows for overrides and suppression of sections from the child dict with the special keywords: `override_field` and `delete_field`

### `report.conf` changes

- [x] `type_name` has been split into `sections` and `compartments`. No need to encode everything in an enum to decode later. This simplifies code and makes the `report.conf`. The code is slightly slower `0(1)` in a part of the code that was not performance-critical
- [x] `scaling` added at the end of the report line (after buffer size)
- [x] add 2 additional binary lines in case of a compartment set report to pass the exact position... (continued)

Run Details

494 of 548 new or added lines in 9 files covered. (90.15%)

4 existing lines in 3 files now uncovered.

7373 of 8163 relevant lines covered (90.32%)

2.28 hits per line