loaders Module#

class neuroml.loaders.ArrayMorphLoader#

Bases: object

classmethod load(filepath)#

Right now this load method isn’t done in a very nice way. TODO: Complete refactoring.

class neuroml.loaders.NeuroMLHdf5Loader#

Bases: object

classmethod load(src, optimized=False)#
class neuroml.loaders.NeuroMLLoader#

Bases: object

classmethod load(src)#
class neuroml.loaders.SWCLoader#

Bases: object

This class is deprecated and will be removed in a future release. Please refer to https://docs.neuroml.org/Userdocs/ImportingMorphologyFiles.html for information on importing/converting morphology files to NeuroML2.

classmethod load_swc_single(src, name=None)#
neuroml.loaders.read_neuroml2_file(nml2_file_name: str, include_includes: bool = False, verbose: bool = False, already_included: list = None, print_method: ~typing.Callable = <function print_>, optimized: bool = False) NeuroMLDocument#

Read a NeuroML2 file into a NeuroMLDocument object

Parameters:
  • nml2_file_name (str) – name of NeuroML file to read

  • include_includes (bool) – toggle whether Included files should also be loaded

  • verbose (bool) – toggle verbose output

  • already_included (list) – list of already included files

  • print_method (Callable) – print function to use

  • optimised (bool) – for optimised HDF5 NeuroML files

Returns:

NeuroMLDoc object containing the read file

neuroml.loaders.read_neuroml2_string(nml2_string: str, include_includes: bool = False, verbose: bool = False, already_included: list = [], print_method: ~typing.Callable = <function print_>, optimized: bool = False, base_path: str | None = None) NeuroMLDocument#

Read a NeuroML2 string into a NeuroMLDocument object

Parameters:
  • nml2_string (str) – NeuroML string to load

  • include_includes (bool) – toggle whether Included files should also be loaded

  • verbose (bool) – toggle verbose output

  • already_included (list) – list of already included files

  • print_method (Callable) – print function to use

  • optimised (bool) – for optimised HDF5 NeuroML files

  • base_path (str) –

Returns:

NeuroMLDoc object containing the model