pyneuroml.modelgraphs module#
Methods related to generating graphical representations of NeuroML models
File: pyneuroml/modelgraphs.py
Copyright 2024 NeuroML contributors
- pyneuroml.modelgraphs.generate_lemsgraph(lems_file_name: str, verbose_generate: bool = True) bool #
Generate LEMS graph using jNeuroML
- Parameters:
lems_file_name (str) – LEMS file to parse
verbose_generate (bool) – whether or not jnml should be run with verbosity output
- Returns bool:
True of jnml ran without errors, exits without a return if jnml fails
- pyneuroml.modelgraphs.generate_nmlgraph(nml2_file_name: str, level: int = 1, engine: str = 'dot', **kwargs) None #
Generate NeuroML graph.
- Parameters:
nml2_file_name (str) – NML file to parse
level (int) – level of graph to generate (default: ‘1’)
engine (str) – graph engine to use (default: ‘dot’)
kwargs – other key word agruments to pass to GraphVizHandler See the GraphVizHandler in NeuroMLlite for information on permissible arguments: NeuroML/NeuroMLlite
- pyneuroml.modelgraphs.nml2_to_png(nml2_file_name: str, max_memory: str = '400M', verbose: bool = True) None #
Generate the PNG representation of a NeuroML model using jnml
- Parameters:
nml2_file_name (str) – name of NeuroML2 file to generate PNG for
max_memory (str) – maximum memory allowed for use by the JVM
verbose (bool) – toggle whether jnml should print verbose information
- pyneuroml.modelgraphs.nml2_to_svg(nml2_file_name: str, max_memory: str = '400M', verbose: bool = True) None #
Generate the SVG representation of a NeuroML model using jnml
- Parameters:
nml2_file_name (str) – name of NeuroML2 file to generate SVG for
max_memory (str) – maximum memory allowed for use by the JVM
verbose (bool) – toggle whether jnml should print verbose information