Skip to content

Commit 32ab0ea

Browse files
thoradesjoelund
authored andcommitted
fix links, fix code blocks and some rewriting
1 parent 0991e55 commit 32ab0ea

1 file changed

Lines changed: 30 additions & 33 deletions

File tree

README.rst

Lines changed: 30 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,65 +2,62 @@
22
OMPython
33
########
44

5-
OMPython is a Python interface that uses CORBA (omniORB) or ZeroMQ to communicate with OpenModelica.
5+
OMPython is a Python interface that uses ZeroMQ or CORBA (omniORB) to communicate with OpenModelica.
66

77
Dependencies
88
============
99

10-
Using omniORB (Python 2 only)
11-
-----------------------------
10+
Using ZeroMQ
11+
------------
12+
- Python 2.7 and 3.x supported
13+
- PyZMQ is required
1214

13-
- Python 2.7 is required (omniORB restriction). Download Python from http://www.python.org/download/
14-
- omniORB is required
15-
- Windows: included in the installer of OpenModelica
16-
- Linux: Install omniORB including Python 2 support (the omniidl command needs to be on the PATH)
17-
On Ubuntu, this is done by running `sudo apt-get install omniorb python-omniorb omniidl omniidl-python`
18-
- Installation using `pip` is recommended.
15+
Using omniORB
16+
-------------
17+
- Currently, only Python 2.7 is supported
18+
- omniORB is required:
19+
- Windows: included in the OpenModelica installation
20+
- Linux: Install omniORB including Python 2 support (the omniidl command needs to be on the PATH).
21+
On Ubuntu, this is done by running ``sudo apt-get install omniorb python-omniorb omniidl omniidl-python``
1922

20-
Using ZeroMQ (Python 2 and 3 supported)
21-
---------------------------------------
22-
23-
- Python 2.7 or 3.x.x is required. Download Python from http://www.python.org/download/
24-
- PyZMQ is required.
25-
- Installation using `pip` is recommended.
2623

2724
Installation
2825
============
26+
Installation using ``pip`` is recommended.
2927

3028
Linux
3129
-----
30+
Install the latest OMPython master by running::
3231

33-
```bash
34-
$ python -m pip install https://github.com/OpenModelica/OMPython/archive/master.zip
35-
```
32+
python -m pip install -U https://github.com/OpenModelica/OMPython/archive/master.zip
3633

3734
Windows
3835
-------
36+
Install the version as packaged with your OpenModelica installation by running::
3937

40-
- Add python to your PATH.
41-
- Start command prompt/terminal and execute commands,
42-
```powershell
43-
> cd %OPENMODELICAHOME%\share\omc\scripts\PythonInterface
44-
> python -m pip install .
45-
```
46-
- This will add OMPython to the Python 3rd party libraries.
38+
cd %OPENMODELICAHOME%\share\omc\scripts\PythonInterface
39+
python -m pip install .
4740

4841
Usage
4942
=====
43+
Running the following commads should get you started
44+
45+
.. code-block:: python
46+
47+
import OMPython
48+
help(OMPython)
5049
51-
```python
52-
import OMPython
53-
help(OMPython)
54-
```
50+
or read the `OMPython documentation <https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/ompython.html>`_ online.
5551

5652
Bug Reports
5753
===========
5854

59-
- See OMPython bugs on the [OpenModelica trac](https://trac.openmodelica.org/OpenModelica/query?component=OMPython) or submit a [new ticket](https://trac.openmodelica.org/OpenModelica/newticket).
60-
- [Pull requests](../../pulls) are welcome.
55+
- See OMPython bugs on the `OpenModelica trac <https://trac.openmodelica.org/OpenModelica/query?component=OMPython>`_
56+
or submit a `new ticket <https://trac.openmodelica.org/OpenModelica/newticket>`_.
57+
- `Pull requests <https://github.com/OpenModelica/OMPython/pulls>`_ are welcome.
6158

6259
Contact
6360
=======
6461

65-
Adeel Asghar, adeel.asghar@liu.se<br />
66-
Arunkumar Palanisamy, arunkumar.palanisamy@liu.se
62+
- Adeel Asghar, adeel.asghar@liu.se
63+
- Arunkumar Palanisamy, arunkumar.palanisamy@liu.se

0 commit comments

Comments
 (0)