scaling in coreneuron#32
Conversation
| def write_report_config(output_file, report_name, target_name, report_type, report_variable, | ||
| unit, report_format, target_type, dt, start_time, end_time, gids, | ||
| buffer_size=8): | ||
| buffer_size=8, scaling="Area"): |
There was a problem hiding this comment.
Q: what are the possible/allowed values of the scaling argument (and possibly stupid Q, what is it referring to)? Referencing either the docs or using typing.Literal would be of great help.
There was a problem hiding this comment.
the scaling is mentioned here:
https://sonata-extension.readthedocs.io/en/latest/sonata_simulation.html#reports
atm it can be none or area.
I am not familiar with typing.Literal. May you be more specific of what you want to do? Create an python enum? Where should I put it?
There was a problem hiding this comment.
May you be more specific of what you want to do?
Just to add it as a type hint, i.e. scaling=Literal[None, "Area"] so the reader knows what are the possible inputs. A docstring (mentioning the the link you provided) works too.
Also, is the name case-sensitive? I see the docs have the lowercase version:
“area” (default) converts density to area values.
2 participants
Scaling was never a factor in coreneuron.
My pr aims also to add scaling to coreneuron.
Since the parameter is necessary now, we need to produce reports that are compatible.
This PR is retro-compatible with previous versions of neuron-coreneuron since scaling is added at the end