Skip to content

Commit 12ccab1

Browse files
authored
Update README.md
1 parent cb16e3e commit 12ccab1

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,23 @@
33
[![Build status](https://img.shields.io/travis/ReactionMechanismGenerator/pyrms/master.svg)](https://travis-ci.org/ReactionMechanismGenerator/pyrms)
44
[![codecov](https://codecov.io/gh/ReactionMechanismGenerator/pyrms/branch/master/graph/badge.svg)](https://codecov.io/gh/ReactionMechanismGenerator/pyrms)
55

6-
Python wrapper for the Reaction Mechanism Simulator package for simulating and analyzing large chemical reaction mechanisms.
6+
Python wrapper for the Reaction Mechanism Simulator (RMS) package for simulating and analyzing large chemical reaction mechanisms. Currently only supports python 2.
7+
8+
In theory this wraps all functionality within RMS with two caveats:
9+
10+
1) In jupyter notebooks julia objects don't display the same way in the python kernel as they would in the julia kernel. For example flux diagram generation had to be hard coded into this wrapper to display properly. If this happens please make an issue.
11+
12+
2) There are ways to define julia functions that makes them impossible to call from python using the pyjulia. In most cases this is easy to fix. If you find a case where this happens please make an issue.
13+
14+
## Installation Instructions:
15+
16+
Note:
17+
pyrms currently only supports python 2 so running `python` must open a python 2 kernel.
18+
Installing pyrms links/relinks your julia PyCall module to the python 2 being used.
19+
20+
Run
21+
```
22+
git clone https://github.com/ReactionMechanismGenerator/pyrms.git
23+
cd pyrms
24+
make install
25+
```

0 commit comments

Comments
 (0)