Cellpy – an open-source library for processing and analysis of battery testing data

Cellpy – an open-source library for processing and analysis of battery testing data - Published in JOSS (2024)

https://github.com/jepegit/cellpy

Science Score: 93.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

battery chemistry data-analysis electrochemistry opensource physics

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 6 months ago · JSON representation

Repository

extract and tweak data from electrochemical tests of cells

Basic Info
  • Host: GitHub
  • Owner: jepegit
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 418 MB
Statistics
  • Stars: 94
  • Watchers: 12
  • Forks: 32
  • Open Issues: 33
  • Releases: 3
Topics
battery chemistry data-analysis electrochemistry opensource physics
Created about 10 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Authors

README.md

cellpy-icon

cellpy - a library for assisting in analysing batteries and cells

cellpy cellpy cellpy

This Python Package was developed to help the researchers at IFE, Norway, in their cumbersome task of interpreting and handling data from cycling tests of batteries and cells.

Features

  • Convert testing data into a common format
  • Summarize and compare data
  • Filter out the steps of interest
  • Process and plot the data
  • Do simple and advanced analysis on single datasets as well as collections of datasets
  • And more!

Documentation

The documentation for cellpy is hosted on Read the Docs.

Installation and dependencies

The easiest way to install cellpy is to install with conda or pip.

With conda:

conda install -c conda-forge cellpy

Or if you prefer installing using pip:

python -m pip install cellpy

Have a look at the documentation for more detailed installation procedures, especially with respect to "difficult" dependencies when installing with pip.

License

cellpy is free software made available under the MIT License.

Citing cellpy

If you use cellpy in your work, please cite our paper:

Wind J., Ulvestad A., Abdelhamid M., Mhlen J.P. (2024). Cellpy an open-source library for processing and analysis of battery testing data. Journal of Open Source Software, 9(97), 6236.

DOI

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. If you want to contribute, please have a look at Contributing Guidelines.

Owner

  • Name: Jan Petter Maehlen
  • Login: jepegit
  • Kind: user
  • Location: Kjeller, Norway
  • Company: IFE

I am a physicist. And I am a researcher working on silicon as a new material for lithium batteries at IFE in Norway. Now and then I write some code in Python.

JOSS Publication

Cellpy – an open-source library for processing and analysis of battery testing data
Published
May 02, 2024
Volume 9, Issue 97, Page 6236
Authors
Julia Wind ORCID
Institute for Energy Technology, 2007 Kjeller, Norway
Asbjørn Ulvestad ORCID
Institute for Energy Technology, 2007 Kjeller, Norway
Muhammad Abdelhamid ORCID
Institute for Energy Technology, 2007 Kjeller, Norway
Jan Petter Mæhlen ORCID
Institute for Energy Technology, 2007 Kjeller, Norway
Editor
Mojtaba Barzegari ORCID
Tags
python battery cycling electrochemistry data processing data analysis battery testing

GitHub Events

Total
  • Issues event: 23
  • Watch event: 9
  • Issue comment event: 12
  • Push event: 153
  • Pull request event: 9
  • Fork event: 1
  • Create event: 8
Last Year
  • Issues event: 23
  • Watch event: 9
  • Issue comment event: 12
  • Push event: 153
  • Pull request event: 9
  • Fork event: 1
  • Create event: 8

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 2,700
  • Total Committers: 16
  • Avg Commits per committer: 168.75
  • Development Distribution Score (DDS): 0.132
Past Year
  • Commits: 147
  • Committers: 3
  • Avg Commits per committer: 49.0
  • Development Distribution Score (DDS): 0.02
Top Committers
Name Email Commits
jepegit j****e@i****o 2,343
AD\torkv t****a@g****m 214
amundmr a****h@g****m 48
Julia Wind J****d@i****o 36
asbjornu a****d@i****o 16
AnonymousSnek U****n@f****o 11
pyup.io bot g****t@p****o 11
Ozstein o****n@g****m 4
muhammada D****| 4
Amund Midtgard Raniseth a****h@i****o 3
Michael Chon m****n@g****m 2
Mojtaba Barzegari 4****y 2
Rasmus Vester Thøgersen 1****s 2
torvara t****a@n****o 2
Jayce Slesar 4****r 1
carlf c****s@o****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 161
  • Total pull requests: 175
  • Average time to close issues: 5 months
  • Average time to close pull requests: 20 days
  • Total issue authors: 22
  • Total pull request authors: 15
  • Average comments per issue: 1.49
  • Average comments per pull request: 0.21
  • Merged pull requests: 71
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 16
  • Pull requests: 10
  • Average time to close issues: 18 days
  • Average time to close pull requests: about 2 hours
  • Issue authors: 5
  • Pull request authors: 2
  • Average comments per issue: 0.44
  • Average comments per pull request: 0.1
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jepegit (108)
  • ma-sadeghi (9)
  • amundmr (6)
  • morrowrasmus (6)
  • juliawind (4)
  • asbjorul (4)
  • MaximevdHeijden (3)
  • kevinsmia1939 (2)
  • agerwick (2)
  • johnphd (2)
  • inger-emma (2)
  • IFEStephanM (2)
  • JohnBolander (2)
  • jayceslesar (2)
  • cdgriffith (1)
Pull Request Authors
  • pyup-bot (107)
  • jepegit (45)
  • juliawind (10)
  • torvara (6)
  • kevinsmia1939 (3)
  • asbjorul (3)
  • mbarzegary (3)
  • amundmr (2)
  • morrowrasmus (2)
  • inger-emma (2)
  • jayceslesar (1)
  • carlerikfoss (1)
  • chonmj (1)
  • Ozzstein (1)
  • streamengineer (1)
Top Labels
Issue Labels
enhancement (53) documentation (14) bug (13) code improvements (10) builds and CI (6) new feature (5) help wanted (5) good first issue (3) question (2) resolved (2) training (1) wontfix (1) duplicate (1)
Pull Request Labels
enhancement (2) new feature (2) documentation (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 6,181 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 2
    (may contain duplicates)
  • Total versions: 168
  • Total maintainers: 1
pypi.org: cellpy

Extract and manipulate data from battery data testers.

  • Versions: 158
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 6,181 Last month
Rankings
Dependent packages count: 7.3%
Stargazers count: 8.8%
Forks count: 8.8%
Average: 9.8%
Dependent repos count: 11.8%
Downloads: 12.5%
Maintainers (1)
Last synced: 6 months ago
conda-forge.org: cellpy

Extract and manipulate data from different battery cell testers.

  • Versions: 10
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 34.0%
Forks count: 36.7%
Stargazers count: 37.1%
Average: 39.8%
Dependent packages count: 51.2%
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • PyGithub >=1.43.0
  • click >=6.6
  • cookiecutter *
  • cryptography >=1.5.2
  • lmfit >=0.9.7
  • matplotlib >=1.5.3
  • numpy >=1.16.4
  • openpyxl *
  • pandas >=1.0.0
  • pyodbc >=4.0.16
  • pytables >=3.5.1
  • python-box *
  • ruamel.yaml *
  • scipy >=0.19.0
  • setuptools >=35.0.1
  • sqlalchemy *
  • sqlalchemy-access *
  • tqdm *
  • xlrd *
requirements_appveyor.txt pypi
  • PyGithub >=1.43
  • click >=6.6
  • cookiecutter *
  • cryptography >=1.5.2
  • lmfit >=0.9.7
  • matplotlib >=1.5.3
  • numpy >=1.16.4
  • openpyxl *
  • pandas >=1.0
  • pyodbc >=4.0.16
  • pytest >=6.0
  • pytest-benchmark *
  • pytest-timeout *
  • python-box *
  • ruamel.yaml *
  • setuptools >=35.0.1
  • sqlalchemy *
  • sqlalchemy-access *
  • tqdm *
  • xlrd *
requirements_dev.txt pypi
  • Sphinx >=1.5.5 development
  • black * development
  • build * development
  • cookiecutter * development
  • coverage >=4.3.4 development
  • cryptography >=1.8.1 development
  • flake8 >=3.3.0 development
  • invoke * development
  • numpy >=1.16.4 development
  • pip >=9.0.1 development
  • pytest >=3.0.7 development
  • pytest-benchmark * development
  • pytest-timeout * development
  • python-box * development
  • python-dotenv * development
  • requests * development
  • ruamel.yaml * development
  • sqlalchemy * development
  • sqlalchemy-access * development
  • tqdm * development
  • twine >=1.9.1 development
  • watchdog >=0.8.3 development
  • wheel >=0.29.0 development
.github/workflows/pytest_posix.yml actions
  • actions/checkout v3 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/pytest_win.yml actions
  • actions/checkout v2 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/test-win.yml actions
  • actions/checkout v2 composite
frozen_requirement.txt pypi
  • click ==8.0.3
  • invoke ==1.6.0
  • lmfit ==1.0.3
  • matplotlib ==3.5.0
  • numpy ==1.21.2
  • pandas ==1.3.4
  • pint ==0.19.2
  • pygithub ==1.55
  • pyodbc ==4.0.32
  • pytest ==6.2.4
  • python-dateutil ==2.8.2
  • python-dotenv ==0.20.0
  • requests ==2.26.0
  • scipy ==1.7.1
  • setuptools ==58.0.4
  • sqlalchemy ==1.4.31
  • tqdm ==4.62.3
environment.yml pypi
  • sqlalchemy-access *