liibra.jl

Create reduced-order state-space models for lithium-ion batteries utilising realisation algorithms.

https://github.com/bradyplanden/liibra.jl

Science Score: 57.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
    Found 4 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary

Keywords

battery battery-models bms control control-systems julia lithium-ion reduced-order-models

Keywords from Contributors

pde neural-operators pinn interpretability meshing fluxes standardization
Last synced: 6 months ago · JSON representation ·

Repository

Create reduced-order state-space models for lithium-ion batteries utilising realisation algorithms.

Basic Info
  • Host: GitHub
  • Owner: BradyPlanden
  • License: mit
  • Language: Julia
  • Default Branch: main
  • Homepage:
  • Size: 254 MB
Statistics
  • Stars: 33
  • Watchers: 2
  • Forks: 6
  • Open Issues: 10
  • Releases: 10
Topics
battery battery-models bms control control-systems julia lithium-ion reduced-order-models
Created over 5 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

Lithium-ion Battery Realisation Algorithms (LiiBRA)

Build Status SciML Code Style ColPrac: Contributor's Guide on Collaborative Practices for Community Packages DOI:10.1016/j.est.2022.105637

Create and Simulate Reduced Order Lithium-Ion Battery Models

LiBRA provides an open-source implementation of realisation algorithms used for generating reduced-order state-space models. This work aims to develop real-time capable physics-informed models for deployment onto embedded hardware. LiiBRA provides capabilities in offline and online model creation, as well as a framework for lithium-ion degradation predictions. For more information on LiiBRA, and the computationally-informed discrete realisation algorithm (CI-DRA), please refer to the publication above.

Further examples are located in the "examples" directory. Please open an issue if you have requests or ideas for additional examples.

Install (Julia 1.7 and later)

julia (v1.7) pkg> add LiiBRA

(Type ] to enter package mode.)

Example Usage

julia using LiiBRA, Plots

Setup: julia Sₑ = 4 Sₛ = 2 Cell = Construct("LG M50") Spatial!(Cell, Sₑ, Sₛ) Ŝ = collect(1.0:-0.25:0.0) SOC = 0.75 Cell.Const.T = 298.15

Realisation: julia A,B,C,D = Realise(Cell,Ŝ);

HPPC Simulation: julia Results = HPPC(Cell,Ŝ,SOC,4.0,-3.0,A,B,C,D);

Plotting Results: julia plotly() plot(Results.t, Results.Cell_V; legend=:topright, color=:blue, bottom_margin=5Plots.mm, left_margin = 5Plots.mm, right_margin = 15Plots.mm, ylabel = "Terminal Voltage (V)", xlabel = "Time (s)", title="HPPC Voltage", label="Voltage", size=(1280,720) )

julia plot(Results.t, Results.Ce; legend=:topright, bottom_margin=5Plots.mm, left_margin = 5Plots.mm, right_margin = 15Plots.mm, ylabel = "Electrolyte Concen. (mol/m³)", xlabel = "Time (s)", title="Electrolyte Concentration", label=["Neg. Separator Interface" "Neg. Current Collector" "Pos. Current Collector" "Pos. Separator Interface"], size=(1280,720) )

julia plot(Results.t, Results.Cseₚ; legend=:topright, bottom_margin=5Plots.mm, left_margin = 5Plots.mm, right_margin = 15Plots.mm, ylabel = "Concentration (mol/m³)", xlabel = "Time (s)", title="Positive Electrode Concentration", label=["Current Collector" "Separator Interface"], size=(1280,720) )

julia plot(Results.t, Results.Cseₙ; legend=:topright, bottom_margin=5Plots.mm, left_margin = 5Plots.mm, right_margin = 15Plots.mm, ylabel = "Concentration (mol/m³)", xlabel = "Time [s]", title="Negative Electrode Concentration", label=["Current Collector" "Separator Interface"], size=(1280,720) )

Bug Tracking

Please report any issues using the Github issue tracker. All feedback is welcome.

Owner

  • Name: Brady Planden
  • Login: BradyPlanden
  • Kind: user
  • Location: Oxford, UK
  • Company: University of Oxford

Postdoctoral Researcher @ University of Oxford

Citation (CITATION.cff)

cff-version: 1.1.0
message: "Please cite below if you use LiiBRA.jl"
authors: 
- family-names: Planden
  given-names: Brady
  orcid: "https://orcid.org/0000-0002-1082-9125"
- family-names: Lukow
  given-names: Katie
  orcid: "https://orcid.org/0000-0002-6752-1439"
- family-names: Henshall
  given-names: Paul
  orcid: "https://orcid.org/0000-0002-6592-2239"
- family-names: Collier
  given-names: Gordana
  orcid: "https://orcid.org/0000-0002-1091-9243"
- family-names: Morrey
  given-names: Denise
  orcid: "https://orcid.org/0000-0002-0105-3425"
journal: "Journal of Energy Storage"
date-released: 2022-11-01
doi: 10.1016/j.est.2022.105637
keywords: 
  - "lithium-ion battery"
  - "battery management system"
  - "reduced-electrochemical model"
  - "battery modelling" 
  - "julia"
version: "0.3.2"
repository-code: "https://github.com/BradyPlanden/LiiBRA.jl"
title: "A Computationally Informed Realisation Algorithm for Lithium-Ion Batteries Implemented with LiiBRA.jl"

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 237
  • Total Committers: 4
  • Avg Commits per committer: 59.25
  • Development Distribution Score (DDS): 0.055
Past Year
  • Commits: 15
  • Committers: 2
  • Avg Commits per committer: 7.5
  • Development Distribution Score (DDS): 0.133
Top Committers
Name Email Commits
Brady Planden i****o@b****m 224
CompatHelper Julia c****y@j****g 11
katielukow c****w@g****m 1
github-actions[bot] 4****] 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 26
  • Total pull requests: 22
  • Average time to close issues: 2 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 7
  • Total pull request authors: 3
  • Average comments per issue: 2.31
  • Average comments per pull request: 0.05
  • Merged pull requests: 21
  • Bot issues: 0
  • Bot pull requests: 12
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 1.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • BradyPlanden (15)
  • DarioSlaifsteinSk (7)
  • chakravala (1)
  • vpuri3 (1)
  • AverageDaniel (1)
  • shwetankverma28 (1)
  • JuliaTagBot (1)
Pull Request Authors
  • github-actions[bot] (13)
  • BradyPlanden (11)
  • DarioSlaifsteinSk (2)
Top Labels
Issue Labels
bug (3)
Pull Request Labels
enhancement (2)

Packages

  • Total packages: 3
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 27
proxy.golang.org: github.com/bradyplanden/liibra.jl
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
proxy.golang.org: github.com/BradyPlanden/LiiBRA.jl
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
juliahub.com: LiiBRA

Create reduced-order state-space models for lithium-ion batteries utilising realisation algorithms.

  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 9.9%
Stargazers count: 25.0%
Average: 25.5%
Forks count: 28.1%
Dependent packages count: 38.9%
Last synced: 6 months ago

Dependencies

.github/workflows/CI.yml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • codecov/codecov-action v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/CompatHelper.yml actions
  • julia-actions/setup-julia latest composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite