Data

Tools

Indexes

Applications

Experiments

Open Source Science

softpotato_desktop

Open source electrochemistry simulator of typical techniques (CV, CA) and GUI.

https://github.com/oliverrdz/softpotato_desktop

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary

Keywords

butler-volmer-kinetics electrochemistry python simulation

Keywords from Contributors

mesh sequences interactive hacking network-simulation
Last synced: 6 months ago · JSON representation ·

Repository

Open source electrochemistry simulator of typical techniques (CV, CA) and GUI.

Basic Info
  • Host: GitHub
  • Owner: oliverrdz
  • License: gpl-3.0
  • Language: Python
  • Default Branch: master
  • Homepage: https://softpotato.xyz/
  • Size: 4.23 MB
Statistics
  • Stars: 23
  • Watchers: 4
  • Forks: 5
  • Open Issues: 0
  • Releases: 6
Topics
butler-volmer-kinetics electrochemistry python simulation
Created about 6 years ago · Last pushed over 3 years ago
Metadata Files
Readme License Citation

README.md

Soft Potato wiki

Open source electrochemistry simulator.

It simulates cyclic voltammograms and chronoamperograms for planar diffusion assuming Butler-Volmer kinetics. Make sure to use the slide bar at the bottom! For more information visit https://softpotato.xyz.

Binaries

There are Windows 8.1 and Ubuntu 20.10 binaries in the releases page. Make sure to download the latest release available for your system.

Usage

For regular use, download the binary for your system. If you want to tinker with the code, then download the repository. From a terminal and within the Soft Potato directory, run: python python3 SoftPotato.py

Requirements

It requires: + Python 3+ + PyQt5 + Numpy + Matplotlib + PyQTGraph

python pip3 install numpy pip3 install matplotlib pip3 install pyqt5 pip3 install pyqtgraph

Optional for compiling with cython, see below + Cython python pip3 install Cython

Tested with: + Linux (PopOs/Ubuntu 20.10/Manjaro) + Windows 8.1 + MacOS Catalina

Compiling with Cython

The code can be made around 30% faster by cythonizing the main sp.py module. This will particularly help speed up the calculation of finite-differences. To compile to code install first Cython and then run the command

python python3 setup.py build_ext --inplace

Contributing

To report bugs, make suggestions or comments or collaborations, please contact me on Twitter or create a pull request.

Credits

The simulator is based on the "Modelling in Electrochemistry" lectures given by Dr. Guy Denuault.

Screenshots

PopOS 20.10: Screenshot v2.0 Windows 8.1: Screenshot_v2,0

Owner

  • Name: Oliver Rodriguez
  • Login: oliverrdz
  • Kind: user

I am an electrochemists who develops software. Lead developer of softpotato and pypotato.

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Rodriguez"
  given-names: "Oliver"
  orcid: "https://orcid.org/0000-0003-2350-1214"
title: "Soft Potato: an open source electrochemical simulator and toolkit"
version: 1.0.18
doi: 10.26434/chemrxiv-2022-4bs3w
date-released: 2020-04-20
url: "https://github.com/oliverrdz/SoftPotato_Desktop"

GitHub Events

Total
Last Year

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 204
  • Total Committers: 6
  • Avg Commits per committer: 34.0
  • Development Distribution Score (DDS): 0.373
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
oliverrdz 3****z 128
Oliver Rodriguez o****z@g****m 65
mamimela 6****a 5
Oliver Rodriguez o****z 4
dependabot[bot] 4****] 1
Johan Hjelm j****h@d****k 1
Committer Domains (Top 20 + Academic)
dtu.dk: 1

Issues and Pull Requests

Last synced: about 2 years ago

All Time
  • Total issues: 0
  • Total pull requests: 44
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 hours
  • Total issue authors: 0
  • Total pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 44
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • oliverrdz (41)
  • mamimela (1)
  • hjelmj (1)
  • dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (1)

Dependencies

requirements.txt pypi
  • PyOpenGL ==3.1.5
  • PyQt5 ==5.15.4
  • PyQt5-Qt5 ==5.15.2
  • PyQt5-sip ==12.9.0
  • QtPy ==1.9.0
  • numpy ==1.22.0
  • pyqtgraph ==0.12.1
  • vispy ==0.4.0
setup.py pypi