openbraininstitute / neurodamus / 13813033482
90%

DEFAULT BRANCH: main
Ran
Jobs 2
Files 48
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 65.89% (+2.4%) from 63.444%
13813033482

push

github

web-flow 
Unit tests for reporting (#119)

## Context
For unit tests we don't build libsonata-report, therefore we can't
create SONATA reports. Alternatively, we can dump the reporting
variables in ASCII format, as per dission in #98.
This PR adds unit tests to check reporting functionalities, mainly
`Node.enable_reports()` and `report.py`. For compartment reports, a test
dumps the reporting values to ASCII report files and check the values.

## Scope
- Remove the unused legacy parameter `ReportingBufferSize`
(https://github.com/openbraininstitute/neurodamus/issues/146)
- In `Node.enable_reports()`, remove the checks for sonata configuration
parameters which should have been checked by libsonata parser.
- In `tests/utils.py`, new functions for recording compartment reports,
and write/read the ascii report files.

## Testing
New `tests/unit/test_ringcells_reports.py` for testing the variables
reports for NEURON and CoreNEURON. It also takes over some tests from
`tests/integration-e2e/test_reports.py`.
However, the test for creating synapse report stays in
`tests/integration-e2e/test_reports.py` because we can't create it with
the current ring circuit (lack of synapses per cell).

## Review
* [x] PR description is complete
* [x] Coding style (imports, function length, New functions, classes or
files) are good
* [x] Unit/Scientific test added
* [ ] Updated Readme, in-code, developer documentation

---------

Co-authored-by: Alessandro Cattabiani <cattabiani@users.noreply.github.com>

1 of 4 new or added lines in 3 files covered. (25.0%)

3009 existing lines in 34 files now uncovered.

5936 of 9009 relevant lines covered (65.89%)

0.9 hits per line

New Missed Lines in Diff

Lines Coverage ∆ File
1
0.0
 -100.0% neurodamus/utils/dump_cellstate.py
2
14.26
 -43.83% neurodamus/node.py

Uncovered Existing Lines

Lines Coverage ∆ File
2
29.21
 -2.25% neurodamus/modification_manager.py
3
40.0
 -4.29% neurodamus/gap_junction.py
7
71.05
 -18.42% neurodamus/core/mechanisms.py
7
38.57
 -10.0% neurodamus/core/_shmutils.py
7
20.0
 -12.73% neurodamus/lfp_manager.py
9
50.0
 -32.14% neurodamus/utils/compat.py
10
52.73
 -18.18% neurodamus/core/_engine.py
16
5.56
 -88.89% neurodamus/utils/cli.py
19
39.44
 -26.76% neurodamus/core/_mpi.py
19
31.65
 -24.05% neurodamus/replay.py
22
19.51
 -53.66% neurodamus/core/random.py
28
40.0
 -28.0% neurodamus/utils/timeit.py
29
41.79
 -43.28% neurodamus/core/_utils.py
32
22.54
 -7.67% neurodamus/stimulus_manager.py
33
22.19
 -10.03% neurodamus/utils/memory.py
35
37.31
 -52.24% neurodamus/core/_neurodamus.py
37
39.32
 -31.62% neurodamus/utils/pyutils.py
43
31.17
 -55.84% neurodamus/utils/logging.py
55
25.98
 -43.31% neurodamus/utils/progressbar.py
57
35.71
 -58.16% neurodamus/utils/multimap.py
67
0.0
 -100.0% neurodamus/utils/dump_cellstate.py
74
33.14
 -43.79% neurodamus/core/_neuron.py
79
11.73
 -48.77% neurodamus/io/cell_readers.py
85
34.16
 -42.08% neurodamus/metype.py
116
18.52
 -71.6% neurodamus/morphio_wrapper.py
143
24.64
 -51.81% neurodamus/io/synapse_reader.py
145
27.5
 -60.42% neurodamus/core/nodeset.py
153
23.61
 -25.8% neurodamus/cell_distributor.py
177
20.49
 -72.54% neurodamus/io/sonata_config.py
186
22.64
 -53.3% neurodamus/target_manager.py
202
25.35
 -47.42% neurodamus/connection.py
206
20.16
 -79.84% neurodamus/core/stimuli.py
404
17.23
 -61.59% neurodamus/connection_manager.py
502
14.26
 -43.83% neurodamus/node.py
Subprojects
ID Flag name Job ID Ran Files Coverage
1 baseline 13813033482.1 48
24.34
 GitHub Action Run
2 unit 13813033482.2 48
65.5
 GitHub Action Run
Source Files on build 13813033482