Welcome to modparc Modelica Parser’s documentation!¶
Contents:
modparc¶
modparc is a Modelica parser in Python based on parser combinator.
- Free software: GNU General Public License v3
- Source code: https://github.com/xie-dongping/modparc.
- Documentation: https://modparc.readthedocs.io.
Contents
Quickstart¶
Install the package from PyPI:
$ pip install modparc
To parse a Modelica source file “your_modelica_file.mo”:
import modparc
model_definition = modparc.parse_file("your_modelica_file.mo")
To list all the equations in the model_definition instance:
all_equations = model_definition.search('Equation')
for equation in all_equations:
print(equation.code()) # The code of the equation as string
To get the name of the model loaded:
print(model_definition.name()) # get the name of the stored class
print(model_definition.class_type()) # get the type of the class
Known Issues¶
- Handling tokenization of Q-IDENT and comments, which comes first?
- Assertion syntax not defined in Modelica specification
- Default recursion depth is not enough for long vector literals
- Cyclic import is neccessary for the Modelica syntax definition
Credits¶
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
The test cases used code from the `ModelicaByExample library (MIT License by Michael Tiller)`_.
Installation¶
Stable release¶
To install Modelica Parser, run this command in your terminal:
$ pip install modparc
This is the preferred method to install Modelica Parser, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.
From sources¶
The sources for Modelica Parser can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/xie-dongping/modparc
Or download the tarball:
$ curl -OL https://github.com/xie-dongping/modparc/tarball/master
Once you have a copy of the source, you can install it with:
$ python setup.py install
Usage¶
To use modparc in a project:
1 2 3 4 | import modparc
with open("your_modelica_file.mo", 'r') as f:
modelica_source_code = f.read()
model_definition = modparc.parse(modelica_source_code)
|
To list all the equations in the model_definition instance:
5 6 7 | all_equations = model_definition.search('Equation')
for equation in all_equations:
print(equation.code()) # The code of the equation as string
|
One could also parse a certain syntax element in Modelica:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | import modparc
from modparc.syntax import tokenize
source_code = """
if init==InitializationOptions.FixedPopulation then
population = initial_population;
elseif init==InitializationOptions.SteadyState then
der(population) = 0;
else
end if
"""
tokens_list = tokenize(source_code)
if_equation_element = modparc.syntax.equations.if_equation(tokens_list)
sub_equations = if_equation_element.search('Equation')
for equation in sub_equations:
print(equation.code()) # The code of the equation as string
|
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/xie-dongping/modparc/issues.
If you are reporting a bug, please include:
- Your Python version and the result of a pip list
- Detailed steps to reproduce the bug, ideally a test case.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Write Documentation¶
Modelica Parser could always use more documentation, whether as part of the official Parser docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/xie-dongping/modparc/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up modparc for local development.
Fork the modparc repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/modparc.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv modparc $ cd modparc/ $ python setup.py developCreate a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 modparc tests $ python setup.py test or py.test $ toxTo get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-featureSubmit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests, unless it is a minor fix.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/xie-dongping/modparc/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Author¶
- 谢东平 Dongping XIE <dongping.xie.tud@gmail.com>
Contributors¶
None yet. Why not be the first?