Giter Site home page Giter Site logo

kiranvad / pymecsim Goto Github PK

View Code? Open in Web Editor NEW
16.0 4.0 7.0 6.08 MB

Python Cyclic Voltammetry Simulator based on MECSim

License: MIT License

Jupyter Notebook 93.19% Python 6.81%
cyclic-voltammetry electrochemistry catalysys electron-transfer simulation catalysis-informatics python

pymecsim's Issues

Change api

Currently the api involves initiating a mechanism with seperate lists of species and reactions. Species can be obtained from the mechanism. So we change the api to the following:

A = Specie('A', C0=1e-6)
B = Specie('B')
C = Specie('C')
D = Specie('D')

R1 = ChargeTransfer([(A,1),('e',1)],[(B,1)],E0=0.0, ks=1.0e1)
R2 = ChemicalReaction([(B,1),(C,1)],[(A,1),(D,1)], kf=1e8, kb=1e-5)

A reaction now takes tuple of the form (specie, coefficient) instead of dictionary with {'specie.name':coefficient}.

A mechanism can now be initiated by just passing the list of reactions as follows:

rxn = [R1, R2]
mech = Mechanism(rxn)

Also few performances issues needs to be addressed:

  1. Species order to generate input file should be solution species followed surface reaction species.
  2. Species should also follow the order : species on the left side of equations should come first in the
    self.species = species
  3. input files that change for every simulation should be untracked and removed from repository.

Package works only with a Linux machine

The way the package is set up works only with Linux (this is mainly a drawback from the MECSim). Make this explicit in the installation.

  • Add matplotlib as a dependency
  • Fix sim.solve() in the readme example

Runtime error while running sim.solve()

Hi, thanks for creating this python wrapper! I tried installing via pip and also via the current git repo directly but am unable to replicate the notebook demo codes. I'm using a linux subsystem within windows to install your package. The error is as such:

image

How can this be resolved? Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.