|
| 1 | +<div align="center"> |
| 2 | +<img src="otherfile/logo.png" width=250px height=250px> |
| 3 | +<br/> |
| 4 | +<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3" /></a> |
| 5 | +</div> |
| 6 | + |
| 7 | +---------- |
| 8 | + |
| 9 | +## Overview |
| 10 | +OPEM is a open source PEM cell simulation tool |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +### Source Code |
| 15 | +- Download [Version 0.1](https://github.com/ecsim/opem/archive/v0.1.zip) or [Latest Source ](https://github.com/ecsim/opem/archive/master.zip) |
| 16 | +- Run `pip install -r requirements.txt` or `pip3 install -r requirements.txt` (Need root access) |
| 17 | +- Run `python3 setup.py install` or `python setup.py install` (Need root access) |
| 18 | + |
| 19 | +### PyPI |
| 20 | + |
| 21 | + |
| 22 | +- Check [Python Packaging User Guide](https://packaging.python.org/installing/) |
| 23 | +- Run `pip install opem` or `pip3 install opem` (Need root access) |
| 24 | + |
| 25 | +## Usage |
| 26 | + |
| 27 | +### CLI |
| 28 | +- Open `CMD` (Windows) or `Terminal` (UNIX) |
| 29 | +- Run `python -m opem` or `python3 -m opem` |
| 30 | +- Enter PEM cell parameters |
| 31 | + - T : Cell Operation Temperature [K] |
| 32 | + - PH2 : Partial Pressure [atm] |
| 33 | + - PO2 : Partial Pressure [atm] |
| 34 | + - i : Cell load current [A] |
| 35 | + - A : active area [cm2] |
| 36 | + - l : Membrane Thickness [cm] |
| 37 | + - lambda : is an adjustable parameter with a possible maximum value of 23 |
| 38 | + - N : Number Of Single Cells |
| 39 | +- Find Your Result In `Simulation-Result.opem` file (Open with Notepad) |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | +## Issues & Bug Reports |
| 44 | + |
| 45 | +Just fill an issue and describe it. We'll check it ASAP! |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | +## Contribution |
| 50 | + |
| 51 | +You can fork the repository, improve or fix some part of it and then send the pull requests back if you want to see them here. I really appreciate that. ❤️ |
| 52 | + |
| 53 | +Remember to write a few tests for your code before sending pull requests. |
| 54 | + |
| 55 | + |
| 56 | + |
| 57 | +## License |
| 58 | + |
| 59 | +<a href="https://github.com/ecsim/opem/blob/master/LICENSE"><img src="https://img.shields.io/github/license/mashape/apistatus.svg"/></a> |
| 60 | + |
| 61 | + |
| 62 | +## Donate to our project |
| 63 | + |
| 64 | +<h3>Bitcoin :</h3> |
| 65 | + |
| 66 | +```12Xm1qL4MXYWiY9sRMoa3VpfTfw6su3vNq``` |
| 67 | + |
| 68 | + |
| 69 | + |
| 70 | +<h3>Payping (For Iranian citizens) :</h3> |
| 71 | + |
| 72 | +<a href="http://www.payping.net/sepandhaghighi" target="__blank"><img src="http://www.qpage.ir/images/payping.png" height=100px width=100px></a> |
0 commit comments