diff --git a/README.md b/README.md index a35d360c..a9cf3bdc 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # OMPython [![License: OSMC-PL-RT](https://img.shields.io/badge/license-OSMC--PL--RT-lightgrey.svg)](LICENSE) -OMPython is a Python interface that uses ZeroMQ to -communicate with OpenModelica. +OMPython is a Python interface that uses ZeroMQ to communicate with OpenModelica. [![Test](https://github.com/OpenModelica/OMPython/actions/workflows/Test.yml/badge.svg)](https://github.com/OpenModelica/OMPython/actions/workflows/Test.yml) +[![PyPI Version](https://img.shields.io/pypi/v/OMPython.svg)](https://pypi.org/project/OMPython/) +[![Conda Version](https://img.shields.io/conda/vn/conda-forge/ompython.svg)](https://anaconda.org/conda-forge/ompython) ## Dependencies @@ -20,11 +21,20 @@ Installation using `pip` is recommended. pip install OMPython ``` +### Via conda + +OMPython is also available as a conda package via [conda-forge](https://conda-forge.org/) + +```bash +conda install -c conda-forge ompython +``` +See the [ompython-feedstock](https://github.com/conda-forge/ompython-feedstock) for details. + ### Via source Clone the repository and run: -``` +```bash cd python -m pip install -U . ``` @@ -49,14 +59,15 @@ online. ## Bug Reports - - Submit bugs through the [OpenModelica GitHub issues](https://github.com/OpenModelica/OMPython/issues/new). - - [Pull requests](https://github.com/OpenModelica/OMPython/pulls) are welcome. +- Submit bugs through the [OpenModelica GitHub issues](https://github.com/OpenModelica/OMPython/issues/new). +- [Pull requests](https://github.com/OpenModelica/OMPython/pulls) are welcome. ## Development -It is recommended to set up [`pre-commit`](https://pre-commit.com/) to -automatically run linters: -```sh + +It is recommended to set up [`pre-commit`](https://pre-commit.com/) to automatically run linters: + +```bash # cd to the root of the repository pre-commit install ``` @@ -67,5 +78,5 @@ This project is licensed under the OSMC Public Runtime License. See [LICENSE](LI ## Contact - - Adeel Asghar, - - Arunkumar Palanisamy, +- Adeel Asghar, +- Arunkumar Palanisamy,