ecsim / opem Goto Github PK

• There are several grammar/syntax errors throughout the example that reduce the readability of the document.
• E.g.,:
  • is a parametric model that predicting the performance
  • Main concepts in the Amphlett model includes Nernst voltage, PEMFC
  • This parametric model of PEMFC using a combination of mechanistic and empirical approach.
  • For most fuel cells and their practical operating range, a linear approximation

E.g.,:

• This model based on some assumption such; the gases are ideal,
• ..., The channels that transport gases along the electrodes have a fixed volume, only source of losses is ohmic and Nernst equation can be applied too.
• For most fuel cells and their practical operating range, a linear approximation is actually a very good fit

Add overall parameters to reports

• E.g.,:

  opem/opem/Static/Amphlett.py

  Lines 22 to 25 in d9748c6

  	try:
  	return i*((N*Eth)-VStack)
  	except Exception:
  	return None

• See the following links for why this is considered poor coding practice:
  • https://stackoverflow.com/questions/10594113/bad-idea-to-catch-all-exceptions-in-python
  • https://stackoverflow.com/questions/2416316/why-is-the-catchexception-almost-always-a-bad-idea
  • https://softwareengineering.stackexchange.com/questions/164256/is-catching-general-exceptions-really-a-bad-thing
• If this is really necessary, the reasoning should be commented.

• Requirements are doubly defined in both

• This can lead to out-of-sync code
• See links in #39 for more information on good practice

• It would be preferable if the package was tested against flake8
• Linting helps maintain a robust and healthy code-base
• Related issue: #37
• References:
  • https://medium.com/python-pandemonium/what-is-flake8-and-why-we-should-use-it-b89bd78073f2
  • https://simpleisbetterthancomplex.com/packages/2016/08/05/flake8.html

Create OPEM Telegram Bot

Add models descriptions to notebook

• Given PyPi's check-manifest tool:

$ check-manifest

lists of files in version control and sdist do not match!
missing from sdist:
  AUTHORS.md
  CHANGELOG.md
  CONTRIBUTING.md
  Documents
  Documents/Amphlett.ipynb
  Documents/Chamberline_Kim.ipynb
  Documents/Larminie_Dicks.ipynb
  Documents/Padulles1.ipynb
  Documents/Padulles2.ipynb
  Documents/Padulles_Amphlett.ipynb
  Documents/Padulles_Hauer.ipynb
  Documents/README.md
  Documents/images
  Documents/images/Padulles-Amphlett-Diagram.jpg
  Documents/images/Padulles-Diagram.jpg
  Documents/images/Padulles-Hauer-Diagram.jpg
  Documents/images/Padulles2-Diagram.jpg
  Documents/images/Static-Model-Graphic.jpg
  INSTALL.md
  OPEM.spec
  PEM.md
  appveyor.yml
  otherfile
  otherfile/Fuel Cell Graphic.gif
  otherfile/OPEM_BLOCK_DIAGRAM.jpg
  otherfile/PEMFC1.jpg
  otherfile/PEMFC2.jpg
  otherfile/Version.rc
  otherfile/icon.ico
  otherfile/logo.png
  otherfile/test.csv
  otherfile/test.html
  otherfile/test.opem
  paper
  paper/paper.bib
  paper/paper.md
  requirements.txt
suggested MANIFEST.in rules:
  include *.md
  include *.spec
  include *.txt
  include *.yml
  recursive-include Documents *.ipynb
  recursive-include Documents *.jpg
  recursive-include Documents *.md
  recursive-include otherfile *.csv
  recursive-include otherfile *.gif
  recursive-include otherfile *.html
  recursive-include otherfile *.ico
  recursive-include otherfile *.jpg
  recursive-include otherfile *.opem
  recursive-include otherfile *.png
  recursive-include otherfile *.rc
  recursive-include paper *.bib
  recursive-include paper *.md

• Files and directories should be explicitly included/excluded/pruned from MANIFEST.ini

• Efficiency vs I
• PH2 vs I
• PO2 vs I
• Power vs R
• Anode/Cathode
• Power vs Efficiency

1- Evaluation the Possibility of Reducing the Total Number of Input Values
2- Renew the Block Diagrams by Edraw Max

Fix each model simulation function exception

E.g.,:

• In addition to the decreasing fuel sources, also pollution and global ...

• reaction between hydrogen-rich fuel source and oxygen

• ... of these devices owing to high efficiency relative

• PEM fuel cells are a high-efficiency power source without pollution for urban vehicles, corroborated by recent legislative initiatives, That’s why these devices have become a great deal of attention to the option of fuel-cell-powered vehicles

• Best fuel for fuel cell powered vehicle is hydrogen,

• because the water is an only product of the reaction between hydrogen and air

• protons that, flow via the membrane to the cathode

• An external circuit that linked to the two electrodes containing the collection of electrons as electrical current

• water and heat will be produced from the protons that flowing via the electrolyte membrane

• The OPEM (software named based on open proton exchange membrane) written in Python, Python is a language that is very powerful for developers, but is also accessible to scientists.

• In addition, dynamic models improve static models and complete the simulation process.

• fluid science and material merge

• make the simulation of fuel cell more

• Simple linear regression used for this approximation and useful overall parameters such P(Thermal) and P(Elec) calculated by Simpson’s Rule

• The method for using in this software is the specified inputs are presented according to the equations of each model by the user and outputs is in

• That is represented by means of its voltage-current characteristic obtained in static operating mode

• That the electrodes channel temperatures/pressures, t...

• variables or constants and in model II, N... (split sentence)

• Also, watch out for arbitrary capitalization, e.g.,: hydrogen vs Hydrogen

SciPy and NumPy are considered the gold-standard and foundations of the Python scientific stack. Several functions can easily be replaced by these well-documented and tested packages.

E.g.,

Can easily be replaced by numpy.trapz or scipy.integrate.trapz

E.g.,:

• or most fuel cells and their practical operating range, a linear approximation is actually a very good fit

Input warning system based on incorrect outputs

In its current form, PEM.md is plagiarized, word-for-word, from http://physics.oregonstate.edu/~hetheriw/energy/topics/doc/electrochemistry/fc/basic/The_Polymer_Electrolyte_Fuel_Cell.htm

The statement Previously, some research on modeling and simulation of PEMFC has been performed is not backed with references.

Add help page to OPEM

• opem/requirements.txt
• Look into https://pyup.io for automated dependency management
• Considering this is an application and not an extensible library, the requirements should be pinned to specific versions in order to guarantee reproducibility.
• Unpinned requirements can lead to sudden CI failures.
• See the following links for best practice:
  • https://packaging.python.org/discussions/install-requires-vs-requirements/
  • https://caremad.io/posts/2013/07/setup-vs-requirement/
  • https://docs.pipenv.org/

Add OPEM block diagram to README.md

• Especially in examples
  • E.g.,: https://github.com/ECSIM/opem/blob/master/Documents/Amphlett.ipynb
    • It is not obvious where xi1, xi2, etc come from
• Most linters will flag from module import * with a warning, because it's prone to namespace collisions

Add notebooks HTML files to opem webpage

• Currently, all testing is consolidated in opem/opem/test.py as a pseudo-doctest file
  • This is actually improper usage of doctests
  • It is hard to understand how and what is being tested
• If doctests are to be used, they should be implemented in the docstrings
• Otherwise, testing should use a proper framework
• See http://docs.python-guide.org/en/latest/writing/tests/ for best practices

Error : The application was unable to start correctly (0xc000007b). Click OK to close the application.

I suggest moving install and contributing parts to INSTALL.md and CONTRIBUTING.md

• Modelling/Modeling used interchangeably throughout documentation and source code
• Pick one:
  • Modelling = international
  • Modeling = US

Create Gitter Community For OPEM

• It would be preferable if the package followed PEP8 guidelines
• From the PEP8 documentation:

One of Guido's key insights is that code is read much more often than it is written. The guidelines provided here are intended to improve the readability of code and make it consistent across the wide spectrum of Python code. As PEP 20 says, "Readability counts".

A style guide is about consistency. Consistency with this style guide is important. Consistency within a project is more important. Consistency within one module or function is the most important.