search

suny-downstate-medical-center / netpyne

A Python package to facilitate the development, parallel simulation, optimization and analysis of multiscale biological neuronal networks in NEURON.
http://www.netpyne.org
MIT License
148 stars 138 forks source link

[Bug report][enhancement] sim.checkOutput() does not provide real output information #608

Closed jpalma-espinosa closed 3 years ago

jpalma-espinosa commented 3 years ago

Describe the bug

Mismatch: model tut2 numSpikes is 400 but expected value is 931

Reproducing the bug

Steps to reproduce the behavior:

  1. Download and Open 'tut2.py'
  2. Run the example. It will work smoothly
  3. Change netParams.stimSourceParams['bkg'] = {'type': 'NetStim', 'rate': 10, 'noise': 0.5} to netParams.stimSourceParams['bkg'] = {'type': 'NetStim', 'rate': 10, 'noise': 0}(i.e., change the noise)
  4. Plots are generated but the error is raised

Expected behavior

I would expect that checkOutput would do a revision of my simulation parameters or something more insightful regarding the output, as the name suggests System information

Additional context

Checking the implementation of sim.checkOutput('tut2'), it only serves for replicating the exact same experiment. It does not provide any more help, nor information regarding the simulation output. I feel that this function does not provide enough information if one wants to test or play around with the tutorials, as this output (and for other tutorials) is fixed. Also, this behavior is not explained in the tutorial webpage

joewgraham commented 3 years ago

Hi @jpalma-espinosa , thanks for the bug report. The function sim.checkOutput is only meant to be used internally by NetPyNE (for code testing/continuous integration).

I added a docstring to checkOutput and added a comment explaining its purpose to each tutorial and example where it was utilized.