Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ECSIM/gopem
GUI for OPEM library
https://github.com/ECSIM/gopem
chemistry electrochemistry fuel-cell matplotlib opem physics physics-simulation pyqt5 python qt5 simulation
Last synced: 3 months ago
JSON representation
GUI for OPEM library
- Host: GitHub
- URL: https://github.com/ECSIM/gopem
- Owner: ECSIM
- License: mit
- Created: 2018-08-26T17:59:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-04T07:58:32.000Z (5 months ago)
- Last Synced: 2024-06-11T17:43:15.981Z (5 months ago)
- Topics: chemistry, electrochemistry, fuel-cell, matplotlib, opem, physics, physics-simulation, pyqt5, python, qt5, simulation
- Language: Python
- Homepage: http://gopem.ecsim.site
- Size: 4.55 MB
- Stars: 31
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Authors: AUTHORS.md
Awesome Lists containing this project
- open-sustainable-technology - gopem - GOPEM is a graphical user interface of OPEM. (Energy Storage / Hydrogen)
README
--------
## Table of Contents
* [Overview](https://github.com/ECSIM/gopem#overview)
* [Installation](https://github.com/ECSIM/gopem#installation)
* [Usage](https://github.com/ECSIM/gopem#usage)
* [Issues & Bug Reports](https://github.com/ECSIM/gopem#issues--bug-reports)
* [Contribution](https://github.com/ECSIM/gopem/blob/master/.github/CONTRIBUTING.md)
* [Thanks](https://github.com/ECSIM/gopem#thanks)
* [Cite](https://github.com/ECSIM/gopem#cite)
* [Authors](https://github.com/ECSIM/gopem/blob/master/AUTHORS.md)
* [License](https://github.com/ECSIM/gopem/blob/master/LICENSE)
* [Show Your Support](https://github.com/ECSIM/gopem#show-your-support)
* [Changelog](https://github.com/ECSIM/gopem/blob/master/CHANGELOG.md)
* [Code of Conduct](https://github.com/ECSIM/gopem/blob/master/.github/CODE_OF_CONDUCT.md)
## Overview
GOPEM is a graphical user interface of [OPEM (Open Source PEM Fuel Cell Simulation Tool)](https://github.com/ECSIM/opem "OPEM").
Branch
master
develop
CI
Code Quality
## Installation
### Source Code
- Download and install [Python3.x](https://www.python.org/downloads/) (>=3.6)
- [x] Select `Add to PATH` option
- [x] Select `Install pip` option
- Download [Version 0.8](https://github.com/ecsim/gopem/archive/v0.8.zip) or [Latest Source ](https://github.com/ecsim/gopem/archive/develop.zip)
- Run `pip install .`
### PyPI
- Check [Python Packaging User Guide](https://packaging.python.org/installing/)
- Run `pip install gopem==0.8`
### Exe Version (Only Windows)
- Download [Installer-Version 0.8](https://github.com/ECSIM/gopem/releases/download/v0.8/GOPEM-0.8.exe) or [Portable-Version 0.8](https://github.com/ECSIM/gopem/releases/download/v0.8/GOPEM-Portable-0.8.exe)
- Run and install
⚠️ The portable build is slower to start
### Exe Version Note
For GOPEM targeting Windows < 10, the user needs to take special care to include the Visual C++ run-time .dlls: Python >=3.5 uses Visual Studio 2015 run-time, which has been renamed into “Universal CRT“ and has become part of Windows 10. For Windows Vista through Windows 8.1 there are Windows update packages, which may or may not be installed in the target-system. So you have the following options:
1. Use [OPEM](https://github.com/ECSIM/opem) (Without GUI)
2. Use [Source Code](https://github.com/ECSIM/gopem#source-code)
3. Download and install [Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48145)
### System Requirements
GOPEM will likely run on a modern dual core PC. Typical configuration is:
- Dual Core CPU (2.0 Ghz+)
- 2GB of RAM
⚠️ Note that it may run on lower end equipment though good performance is not guaranteed.
## Usage
GIF
Screenshot 1
Screenshot 2
- Open `CMD` (Windows) or `Terminal` (UNIX)
- Run `gopem` or `python -m gopem` (or run `GOPEM.exe`)
- Wait about 4-15 seconds (depends on your system specification)
- Enter PEM cell parameters (or run standard test vectors)
- For more information about parameters visit [OPEM (Open Source PEM Fuel Cell Simulation Tool)](https://github.com/ECSIM/opem "OPEM")
## Issues & Bug Reports
Just fill an issue and describe it. We'll check it ASAP!
or send an email to [[email protected]](mailto:[email protected] "[email protected]").
You can also join our discord server
## Thanks
* [PyInstaller](https://github.com/pyinstaller/pyinstaller)
* [Zahra Mobasher](https://www.instagram.com/littleblackoyster/?hl=en) (Logo design)
## Cite
If you use OPEM in your research , please cite this paper :
@article{Haghighi2018,
doi = {10.21105/joss.00676},
url = {https://doi.org/10.21105/joss.00676},
year = {2018},
month = {jul},
publisher = {The Open Journal},
volume = {3},
number = {27},
pages = {676},
author = {Sepand Haghighi and Kasra Askari and Sarmin Hamidi and Mohammad Mahdi Rahimi},
title = {{OPEM} : Open Source {PEM} Cell Simulation Tool},
journal = {Journal of Open Source Software}
}
Download [OPEM.bib](http://www.ecsim.site/opem/OPEM.bib)(BibTeX Format)
JOSS
Zenodo
## Show Your Support
Star This Repo
Give a ⭐️ if this project helped you!
Donate to Our Project
If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .
