Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document sbml #306

Merged
merged 2 commits into from
Feb 19, 2024
Merged

Document sbml #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9025f86
docs(sbml): add docstrings
sanjayankur31 Feb 19, 2024
78a042a
docs: add pyneuroml.sbml
sanjayankur31 Feb 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/pyneuroml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@ The PyNeuroML package includes the following sub-packages:
pyneuroml.povray
pyneuroml.runners
pyneuroml.swc
pyneuroml.sbml
pyneuroml.tune
pyneuroml.utils
7 changes: 7 additions & 0 deletions docs/source/pyneuroml.sbml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pyneuroml.sbml module
======================

.. automodule:: pyneuroml.sbml
:members:
:undoc-members:
:show-inheritance:
13 changes: 9 additions & 4 deletions pyneuroml/sbml/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,15 @@


def validate_sbml_files(input_files: List[str], strict_units: bool = False) -> bool:
"""
validate each input file using libsbml.SBMLDocument.checkConsistency
input_files is a list of one or more filepaths
strict_units converts unit consistency warnings into errors
"""Validate input files using libsbml.SBMLDocument.checkConsistency

:param input_files: a list of one or more filepaths
:type input_files: list(str)
:param strict_units: toggle whether unit consistency warnings should be
treated as errors
:type strict_units: bool
:returns: True if all files are valid, else False
:rtype: bool
"""

if not len(input_files) >= 1:
Expand Down
Loading