biosimulators_pyneuroml.api package

Submodules

biosimulators_pyneuroml.api.brian2 module

biosimulators_pyneuroml.api.brian2.exec_sed_doc(doc, working_dir, base_out_path, rel_out_path=None, apply_xml_model_changes=False, log=None, indent=0, pretty_print_modified_xml_models=False, log_level=StandardOutputErrorCapturerLevel.c, config=None, *, simulator=Simulator.brian2)[source]

Execute the tasks specified in a SED document and generate the specified outputs

Parameters

  • doc (SedDocument or str) – SED document or a path to SED-ML file which defines a SED document

  • working_dir (str) – working directory of the SED document (path relative to which models are located)

  • base_out_path (str) –

    path to store the outputs

    • CSV: directory in which to save outputs to files {base_out_path}/{rel_out_path}/{report.id}.csv

    • HDF5: directory in which to save a single HDF5 file ({base_out_path}/reports.h5), with reports at keys {rel_out_path}/{report.id} within the HDF5 file

  • rel_out_path (str, optional) – path relative to base_out_path to store the outputs

  • apply_xml_model_changes (bool, optional) – if True, apply any model changes specified in the SED-ML file before calling task_executer.

  • log (SedDocumentLog, optional) – log of the document

  • indent (int, optional) – degree to indent status messages

  • pretty_print_modified_xml_models (bool, optional) – if True, pretty print modified XML models

  • log_level (StandardOutputErrorCapturerLevel, optional) – level at which to log output

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

  • ReportResults: results of each report

  • SedDocumentLog: log of the document

Return type

tuple

biosimulators_pyneuroml.api.brian2.exec_sed_task(task, variables, preprocessed_task=None, log=None, config=None, *, simulator=Simulator.brian2)[source]

Execute a task and save its results

Parameters

  • task (Task) – task

  • variables (list of Variable) – variables that should be recorded

  • preprocessed_task (dict, optional) – preprocessed information about the task, including possible model changes and variables. This can be used to avoid repeatedly executing the same initialization for repeated calls to this method.

  • log (TaskLog, optional) – log for the task

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

VariableResults: results of variables TaskLog: log

Return type

tuple

Raises

  • ValueError – if the task or an aspect of the task is not valid, or the requested output variables could not be recorded

  • NotImplementedError – if the task is not of a supported type or involves an unsuported feature

biosimulators_pyneuroml.api.brian2.exec_sedml_docs_in_combine_archive(archive_filename, out_dir, config=None, *, simulator=Simulator.brian2)[source]

Execute the SED tasks defined in a COMBINE/OMEX archive and save the outputs

Parameters

  • archive_filename (str) – path to COMBINE/OMEX archive

  • out_dir (str) –

    path to store the outputs of the archive

    • CSV: directory in which to save outputs to files { out_dir }/{ relative-path-to-SED-ML-file-within-archive }/{ report.id }.csv

    • HDF5: directory in which to save a single HDF5 file ({ out_dir }/reports.h5), with reports at keys { relative-path-to-SED-ML-file-within-archive }/{ report.id } within the HDF5 file

  • simulator (Simulator, optional) – simulator

  • config (Config, optional) – BioSimulators common configuration

Returns

  • SedDocumentResults: results

  • CombineArchiveLog: log

Return type

tuple

biosimulators_pyneuroml.api.brian2.get_simulator_version()[source]

Get the version of pyNeuroML

Returns

version

Return type

str

biosimulators_pyneuroml.api.brian2.preprocess_sed_task(task, variables, config=None, *, simulator=Simulator.brian2)[source]

Preprocess a SED task, including its possible model changes and variables. This is useful for avoiding repeatedly initializing tasks on repeated calls of exec_sed_task.

Parameters

  • task (Task) – task

  • variables (list of Variable) – variables that should be recorded

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

preprocessed information about the task

Return type

dict

biosimulators_pyneuroml.api.netpyne module

biosimulators_pyneuroml.api.netpyne.exec_sed_doc(doc, working_dir, base_out_path, rel_out_path=None, apply_xml_model_changes=False, log=None, indent=0, pretty_print_modified_xml_models=False, log_level=StandardOutputErrorCapturerLevel.c, config=None, *, simulator=Simulator.netpyne)[source]

Execute the tasks specified in a SED document and generate the specified outputs

Parameters

  • doc (SedDocument or str) – SED document or a path to SED-ML file which defines a SED document

  • working_dir (str) – working directory of the SED document (path relative to which models are located)

  • base_out_path (str) –

    path to store the outputs

    • CSV: directory in which to save outputs to files {base_out_path}/{rel_out_path}/{report.id}.csv

    • HDF5: directory in which to save a single HDF5 file ({base_out_path}/reports.h5), with reports at keys {rel_out_path}/{report.id} within the HDF5 file

  • rel_out_path (str, optional) – path relative to base_out_path to store the outputs

  • apply_xml_model_changes (bool, optional) – if True, apply any model changes specified in the SED-ML file before calling task_executer.

  • log (SedDocumentLog, optional) – log of the document

  • indent (int, optional) – degree to indent status messages

  • pretty_print_modified_xml_models (bool, optional) – if True, pretty print modified XML models

  • log_level (StandardOutputErrorCapturerLevel, optional) – level at which to log output

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

  • ReportResults: results of each report

  • SedDocumentLog: log of the document

Return type

tuple

biosimulators_pyneuroml.api.netpyne.exec_sed_task(task, variables, preprocessed_task=None, log=None, config=None, *, simulator=Simulator.netpyne)[source]

Execute a task and save its results

Parameters

  • task (Task) – task

  • variables (list of Variable) – variables that should be recorded

  • preprocessed_task (dict, optional) – preprocessed information about the task, including possible model changes and variables. This can be used to avoid repeatedly executing the same initialization for repeated calls to this method.

  • log (TaskLog, optional) – log for the task

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

VariableResults: results of variables TaskLog: log

Return type

tuple

Raises

  • ValueError – if the task or an aspect of the task is not valid, or the requested output variables could not be recorded

  • NotImplementedError – if the task is not of a supported type or involves an unsuported feature

biosimulators_pyneuroml.api.netpyne.exec_sedml_docs_in_combine_archive(archive_filename, out_dir, config=None, *, simulator=Simulator.netpyne)[source]

Execute the SED tasks defined in a COMBINE/OMEX archive and save the outputs

Parameters

  • archive_filename (str) – path to COMBINE/OMEX archive

  • out_dir (str) –

    path to store the outputs of the archive

    • CSV: directory in which to save outputs to files { out_dir }/{ relative-path-to-SED-ML-file-within-archive }/{ report.id }.csv

    • HDF5: directory in which to save a single HDF5 file ({ out_dir }/reports.h5), with reports at keys { relative-path-to-SED-ML-file-within-archive }/{ report.id } within the HDF5 file

  • simulator (Simulator, optional) – simulator

  • config (Config, optional) – BioSimulators common configuration

Returns

  • SedDocumentResults: results

  • CombineArchiveLog: log

Return type

tuple

biosimulators_pyneuroml.api.netpyne.get_simulator_version()[source]

Get the version of pyNeuroML

Returns

version

Return type

str

biosimulators_pyneuroml.api.netpyne.preprocess_sed_task(task, variables, config=None, *, simulator=Simulator.netpyne)[source]

Preprocess a SED task, including its possible model changes and variables. This is useful for avoiding repeatedly initializing tasks on repeated calls of exec_sed_task.

Parameters

  • task (Task) – task

  • variables (list of Variable) – variables that should be recorded

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

preprocessed information about the task

Return type

dict

biosimulators_pyneuroml.api.neuron module

biosimulators_pyneuroml.api.neuron.exec_sed_doc(doc, working_dir, base_out_path, rel_out_path=None, apply_xml_model_changes=False, log=None, indent=0, pretty_print_modified_xml_models=False, log_level=StandardOutputErrorCapturerLevel.c, config=None, *, simulator=Simulator.neuron)[source]

Execute the tasks specified in a SED document and generate the specified outputs

Parameters

  • doc (SedDocument or str) – SED document or a path to SED-ML file which defines a SED document

  • working_dir (str) – working directory of the SED document (path relative to which models are located)

  • base_out_path (str) –

    path to store the outputs

    • CSV: directory in which to save outputs to files {base_out_path}/{rel_out_path}/{report.id}.csv

    • HDF5: directory in which to save a single HDF5 file ({base_out_path}/reports.h5), with reports at keys {rel_out_path}/{report.id} within the HDF5 file

  • rel_out_path (str, optional) – path relative to base_out_path to store the outputs

  • apply_xml_model_changes (bool, optional) – if True, apply any model changes specified in the SED-ML file before calling task_executer.

  • log (SedDocumentLog, optional) – log of the document

  • indent (int, optional) – degree to indent status messages

  • pretty_print_modified_xml_models (bool, optional) – if True, pretty print modified XML models

  • log_level (StandardOutputErrorCapturerLevel, optional) – level at which to log output

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

  • ReportResults: results of each report

  • SedDocumentLog: log of the document

Return type

tuple

biosimulators_pyneuroml.api.neuron.exec_sed_task(task, variables, preprocessed_task=None, log=None, config=None, *, simulator=Simulator.neuron)[source]

Execute a task and save its results

Parameters

  • task (Task) – task

  • variables (list of Variable) – variables that should be recorded

  • preprocessed_task (dict, optional) – preprocessed information about the task, including possible model changes and variables. This can be used to avoid repeatedly executing the same initialization for repeated calls to this method.

  • log (TaskLog, optional) – log for the task

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

VariableResults: results of variables TaskLog: log

Return type

tuple

Raises

  • ValueError – if the task or an aspect of the task is not valid, or the requested output variables could not be recorded

  • NotImplementedError – if the task is not of a supported type or involves an unsuported feature

biosimulators_pyneuroml.api.neuron.exec_sedml_docs_in_combine_archive(archive_filename, out_dir, config=None, *, simulator=Simulator.neuron)[source]

Execute the SED tasks defined in a COMBINE/OMEX archive and save the outputs

Parameters

  • archive_filename (str) – path to COMBINE/OMEX archive

  • out_dir (str) –

    path to store the outputs of the archive

    • CSV: directory in which to save outputs to files { out_dir }/{ relative-path-to-SED-ML-file-within-archive }/{ report.id }.csv

    • HDF5: directory in which to save a single HDF5 file ({ out_dir }/reports.h5), with reports at keys { relative-path-to-SED-ML-file-within-archive }/{ report.id } within the HDF5 file

  • simulator (Simulator, optional) – simulator

  • config (Config, optional) – BioSimulators common configuration

Returns

  • SedDocumentResults: results

  • CombineArchiveLog: log

Return type

tuple

biosimulators_pyneuroml.api.neuron.get_simulator_version()[source]

Get the version of pyNeuroML

Returns

version

Return type

str

biosimulators_pyneuroml.api.neuron.preprocess_sed_task(task, variables, config=None, *, simulator=Simulator.neuron)[source]

Preprocess a SED task, including its possible model changes and variables. This is useful for avoiding repeatedly initializing tasks on repeated calls of exec_sed_task.

Parameters

  • task (Task) – task

  • variables (list of Variable) – variables that should be recorded

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

preprocessed information about the task

Return type

dict

biosimulators_pyneuroml.api.pyneuroml module

biosimulators_pyneuroml.api.pyneuroml.exec_sed_doc(doc, working_dir, base_out_path, rel_out_path=None, apply_xml_model_changes=False, log=None, indent=0, pretty_print_modified_xml_models=False, log_level=StandardOutputErrorCapturerLevel.c, config=None, *, simulator=Simulator.pyneuroml)[source]

Execute the tasks specified in a SED document and generate the specified outputs

Parameters

  • doc (SedDocument or str) – SED document or a path to SED-ML file which defines a SED document

  • working_dir (str) – working directory of the SED document (path relative to which models are located)

  • base_out_path (str) –

    path to store the outputs

    • CSV: directory in which to save outputs to files {base_out_path}/{rel_out_path}/{report.id}.csv

    • HDF5: directory in which to save a single HDF5 file ({base_out_path}/reports.h5), with reports at keys {rel_out_path}/{report.id} within the HDF5 file

  • rel_out_path (str, optional) – path relative to base_out_path to store the outputs

  • apply_xml_model_changes (bool, optional) – if True, apply any model changes specified in the SED-ML file before calling task_executer.

  • log (SedDocumentLog, optional) – log of the document

  • indent (int, optional) – degree to indent status messages

  • pretty_print_modified_xml_models (bool, optional) – if True, pretty print modified XML models

  • log_level (StandardOutputErrorCapturerLevel, optional) – level at which to log output

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

  • ReportResults: results of each report

  • SedDocumentLog: log of the document

Return type

tuple

biosimulators_pyneuroml.api.pyneuroml.exec_sed_task(task, variables, preprocessed_task=None, log=None, config=None, *, simulator=Simulator.pyneuroml)[source]

Execute a task and save its results

Parameters

  • task (Task) – task

  • variables (list of Variable) – variables that should be recorded

  • preprocessed_task (dict, optional) – preprocessed information about the task, including possible model changes and variables. This can be used to avoid repeatedly executing the same initialization for repeated calls to this method.

  • log (TaskLog, optional) – log for the task

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

VariableResults: results of variables TaskLog: log

Return type

tuple

Raises

  • ValueError – if the task or an aspect of the task is not valid, or the requested output variables could not be recorded

  • NotImplementedError – if the task is not of a supported type or involves an unsuported feature

biosimulators_pyneuroml.api.pyneuroml.exec_sedml_docs_in_combine_archive(archive_filename, out_dir, config=None, *, simulator=Simulator.pyneuroml)[source]

Execute the SED tasks defined in a COMBINE/OMEX archive and save the outputs

Parameters

  • archive_filename (str) – path to COMBINE/OMEX archive

  • out_dir (str) –

    path to store the outputs of the archive

    • CSV: directory in which to save outputs to files { out_dir }/{ relative-path-to-SED-ML-file-within-archive }/{ report.id }.csv

    • HDF5: directory in which to save a single HDF5 file ({ out_dir }/reports.h5), with reports at keys { relative-path-to-SED-ML-file-within-archive }/{ report.id } within the HDF5 file

  • simulator (Simulator, optional) – simulator

  • config (Config, optional) – BioSimulators common configuration

Returns

  • SedDocumentResults: results

  • CombineArchiveLog: log

Return type

tuple

biosimulators_pyneuroml.api.pyneuroml.get_simulator_version()[source]

Get the version of pyNeuroML

Returns

version

Return type

str

biosimulators_pyneuroml.api.pyneuroml.preprocess_sed_task(task, variables, config=None, *, simulator=Simulator.pyneuroml)[source]

Preprocess a SED task, including its possible model changes and variables. This is useful for avoiding repeatedly initializing tasks on repeated calls of exec_sed_task.

Parameters

  • task (Task) – task

  • variables (list of Variable) – variables that should be recorded

  • config (Config, optional) – BioSimulators common configuration

  • simulator (Simulator, optional) – simulator

Returns

preprocessed information about the task

Return type

dict