biosimulators_pyneuroml package¶
- biosimulators_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
orstr
) – SED document or a path to SED-ML file which defines a SED documentworking_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 tobase_out_path
to store the outputsapply_xml_model_changes (
bool
, optional) – ifTrue
, apply any model changes specified in the SED-ML file before callingtask_executer
.log (
SedDocumentLog
, optional) – log of the documentindent (
int
, optional) – degree to indent status messagespretty_print_modified_xml_models (
bool
, optional) – ifTrue
, pretty print modified XML modelslog_level (
StandardOutputErrorCapturerLevel
, optional) – level at which to log outputconfig (
Config
, optional) – BioSimulators common configurationsimulator (
Simulator
, optional) – simulator
- Returns
ReportResults
: results of each reportSedDocumentLog
: log of the document
- Return type
tuple
- biosimulators_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
) – taskvariables (
list
ofVariable
) – variables that should be recordedpreprocessed_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 taskconfig (
Config
, optional) – BioSimulators common configurationsimulator (
Simulator
, optional) – simulator
- Returns
VariableResults
: results of variablesTaskLog
: 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.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 archiveout_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) – simulatorconfig (
Config
, optional) – BioSimulators common configuration
- Returns
SedDocumentResults
: resultsCombineArchiveLog
: log
- Return type
tuple
- biosimulators_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
) – taskvariables (
list
ofVariable
) – variables that should be recordedconfig (
Config
, optional) – BioSimulators common configurationsimulator (
Simulator
, optional) – simulator
- Returns
preprocessed information about the task
- Return type
dict
Submodules¶
biosimulators_pyneuroml.core module¶
Methods for using pyNeuroML to execute SED tasks in COMBINE archives and save their outputs
- Author
Jonathan Karr <karr@mssm.edu>
- Date
2021-05-28
- Copyright
2021, Center for Reproducible Biomedical Modeling
- License
MIT
- biosimulators_pyneuroml.core.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
orstr
) – SED document or a path to SED-ML file which defines a SED documentworking_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 tobase_out_path
to store the outputsapply_xml_model_changes (
bool
, optional) – ifTrue
, apply any model changes specified in the SED-ML file before callingtask_executer
.log (
SedDocumentLog
, optional) – log of the documentindent (
int
, optional) – degree to indent status messagespretty_print_modified_xml_models (
bool
, optional) – ifTrue
, pretty print modified XML modelslog_level (
StandardOutputErrorCapturerLevel
, optional) – level at which to log outputconfig (
Config
, optional) – BioSimulators common configurationsimulator (
Simulator
, optional) – simulator
- Returns
ReportResults
: results of each reportSedDocumentLog
: log of the document
- Return type
tuple
- biosimulators_pyneuroml.core.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
) – taskvariables (
list
ofVariable
) – variables that should be recordedpreprocessed_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 taskconfig (
Config
, optional) – BioSimulators common configurationsimulator (
Simulator
, optional) – simulator
- Returns
VariableResults
: results of variablesTaskLog
: 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.core.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 archiveout_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) – simulatorconfig (
Config
, optional) – BioSimulators common configuration
- Returns
SedDocumentResults
: resultsCombineArchiveLog
: log
- Return type
tuple
- biosimulators_pyneuroml.core.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
) – taskvariables (
list
ofVariable
) – variables that should be recordedconfig (
Config
, optional) – BioSimulators common configurationsimulator (
Simulator
, optional) – simulator
- Returns
preprocessed information about the task
- Return type
dict