CircuitSimulation.instantiate_gids() currently requires explicit cell IDs. However, the SONATA simulation config already defines which cells to instantiate via the top-level node_set.
Proposal
Introduce a SONATA-aware entry point, for example:
sim.instantiate_from_config()
This should:
- read the top-level
node_set from the simulation config
- resolve the corresponding cells internally via libsonata /
circuit_access
- follow SONATA defaults if no
node_set is defined
Why
- Align with SONATA semantics
- Avoid upfront ID materialization in upstream tools
- Keep
instantiate_gids() as the low-level API for explicit IDs
Note
SONATA target resolution already exists internally, e.g. for stimuli, but not for cell instantiation.
CircuitSimulation.instantiate_gids()currently requires explicit cell IDs. However, the SONATA simulation config already defines which cells to instantiate via the top-levelnode_set.Proposal
Introduce a SONATA-aware entry point, for example:
This should:
node_setfrom the simulation configcircuit_accessnode_setis definedWhy
instantiate_gids()as the low-level API for explicit IDsNote
SONATA target resolution already exists internally, e.g. for stimuli, but not for cell instantiation.