change default cell parameter names to cell chemistry/type instead of reference author

README.md

@@ -52,7 +52,7 @@ using BattMo, GLMakie
 # the cell parameter set from a NMC811 vs Graphite-SiOx cell whose parameters were determined in the [Chen 2020 paper](https://doi.org/10.1149/1945-7111/ab9050). 
 # We also load an example cycling protocol for a simple Constant Current Discharge.
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 
 # Next, we select the Lithium-Ion Battery Model setup with default model settings. 
@@ -99,7 +99,7 @@ using BattMo, GLMakie
 # the cell parameter set from of a commercial Type LP2770120 prismatic LiFePO4/graphite cell whose parameters were determined in the [xU 2015 paper](https://doi.org/10.1016/j.energy.2014.11.073). 
 # We also load an example cycling protocol for a simple Constant Current Discharge.
 
-cell_parameters = load_cell_parameters(; from_default_set = "xu_2015")
+cell_parameters = load_cell_parameters(; from_default_set = "LP2770120_graphite_LFP_prismatic")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p4d_pouch")
 simulation_settings = load_simulation_settings(; from_default_set = "p4d_pouch")

codecov.yml

@@ -0,0 +1,9 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 60%
+        threshold: 1%
+    patch:
+      default:
+        informational: true

docs/generate_geometry_assets.jl

@@ -47,7 +47,7 @@ end
 
 function save_p4d_pouch_geometry()
     println("Generating geometry_p4d_pouch.png")
-    cell_parameters = load_cell_parameters(; from_default_set = "xu_2015")
+    cell_parameters = load_cell_parameters(; from_default_set = "LP2770120_graphite_LFP_prismatic")
     cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
     model_settings = load_model_settings(; from_default_set = "p4d_pouch")
     simulation_settings = load_simulation_settings(; from_default_set = "p4d_pouch")
@@ -103,7 +103,7 @@ end
 
 function save_p4d_cylindrical_geometry()
     println("Generating geometry_p4d_cylindrical.png")
-    cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+    cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
     cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
     model_settings = load_model_settings(; from_default_set = "p4d_cylindrical")
     simulation_settings = load_simulation_settings(; from_default_set = "p4d_cylindrical")

docs/src/manuals/pybattmo/examples.md

@@ -14,7 +14,7 @@ import pandas as pd
 import numpy as np
 
 # Load parameter sets
-cell_parameters = load_cell_parameters(from_default_set="chen_2020")
+cell_parameters = load_cell_parameters(from_default_set="LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(from_default_set="cc_discharge")
 
 # Have a quick look into what kind of cell we're dealing with
@@ -40,7 +40,7 @@ fig.show()
 from battmo import *
 
 # Load parameter sets and settings
-cell_parameters = load_cell_parameters(from_default_set="chen_2020")
+cell_parameters = load_cell_parameters(from_default_set="LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(from_default_set="cc_discharge")
 model_settings = load_model_settings(from_default_set="p4d_cylindrical")
 simulation_settings = load_simulation_settings(from_default_set="p4d_cylindrical")
@@ -80,7 +80,7 @@ exdata = os.path.join(battmo_base, "examples", "example_data")
 df_05 = pd.read_csv(os.path.join(exdata, "Xu_2015_voltageCurve_05C.csv"), names=["Time", "Voltage"])
 
 # ## Load cell parameters and cycling protocol
-cell_parameters = load_cell_parameters(from_default_set="xu_2015")
+cell_parameters = load_cell_parameters(from_default_set="LP2770120_graphite_LFP_prismatic")
 cycling_protocol = load_cycling_protocol(from_default_set="cc_discharge")
 
 cycling_protocol["LowerVoltageLimit"] = 2.25
@@ -177,7 +177,7 @@ fig.show()
 ```python
 from battmo import *
 
-simulation_input = load_full_simulation_input(from_default_set="chen_2020")
+simulation_input = load_full_simulation_input(from_default_set="LG_INR_21700_M50")
 
 output = run_simulation(simulation_input)
 

docs/src/manuals/user_guide/terminology.md

@@ -27,7 +27,7 @@ These parameters characterize the intrinsic properties of a battery cell, such a
       "SurfaceCoefficientOfHeatTransfer": 1000
     }}}
 ```
-All parameter values should be given in **SI units**. An examples of a cell parameter set can be found [here](https://github.com/BattMoTeam/BattMo.jl/blob/6b3316286e4345f0468d465296c49d68292eb1f7/src/input/defaults/cell_parameters/chen_2020.json).
+All parameter values should be given in **SI units**. An examples of a cell parameter set can be found [here](https://github.com/BattMoTeam/BattMo.jl/blob/6b3316286e4345f0468d465296c49d68292eb1f7/src/input/defaults/cell_parameters/LG_INR_21700_M50.json).
 
 ### Cycling Parameters
 These parameters define the operational conditions of the battery during a simulation, such as:

docs/src/validations/arrhenius.md

@@ -28,7 +28,7 @@ using Statistics
 ### Load model with Arrhenius temperature dependence
 
 ````@example arrhenius
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p2d")
 

examples/Experimental/example_chayambuka_calibration.jl

@@ -6,7 +6,7 @@ using GLMakie, StatsBase, Loess
 
 
 battmo_base = normpath(joinpath(pathof(BattMo) |> splitdir |> first, ".."))
-include(joinpath(battmo_base, "src/input/defaults/cell_parameters/function_parameters_chayambuka_2022.jl"))
+include(joinpath(battmo_base, "src/input/defaults/cell_parameters/function_parameters_HC_NVPF_electrodes.jl"))
 
 ######### Load Experimental Data #########
 
@@ -44,7 +44,7 @@ df_14 = smooth_df(df_14)
 
 ######### Load Simulation Data #########
 
-cell_parameters = load_cell_parameters(; from_default_set = "chayambuka_2022")
+cell_parameters = load_cell_parameters(; from_default_set = "HC_NVPF_electrodes")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p2d")
 simulation_settings = load_simulation_settings(; from_default_set = "p2d")

examples/Experimental/multi_layer_pouch.jl

@@ -10,7 +10,7 @@ using Preferences
 
 using BattMo, GLMakie
 
-cell_parameters = load_cell_parameters(; from_default_set = "xu_2015")
+cell_parameters = load_cell_parameters(; from_default_set = "LP2770120_graphite_LFP_prismatic")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p4d_pouch")
 

examples/beginner_tutorials/10_handling_grid_time_resolution.jl

@@ -14,7 +14,7 @@
 using BattMo, GLMakie
 
 # Load cell parameters as before
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 nothing # hide
 
 # To demonstrate changing time resolution we will use a drive cycle to setup a current function.

examples/beginner_tutorials/11_handling_solver_settings.jl

@@ -24,7 +24,7 @@ nothing # hide
 
 # Lets setup a simple simulation to demonstrate the solver settings.
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 
 model = LithiumIonBattery()

examples/beginner_tutorials/1_useful_tools.jl

@@ -72,7 +72,7 @@ nothing # hide
 # ## Get quick information on a cell parameter set
 
 # Let's load a default cell parameter set.
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 nothing # hide
 
 # You can easily print some handy quantities and metrics for debugging:

examples/beginner_tutorials/2_run_a_simulation.jl

@@ -17,7 +17,7 @@ using BattMo, GLMakie
 # We also read an example cycling protocol for a simple Constant Current Discharge.
 
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 
 nothing # hide

examples/beginner_tutorials/3_handle_outputs.jl

@@ -11,7 +11,7 @@
 
 using BattMo, GLMakie
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 nothing # hide
 

examples/beginner_tutorials/4_select_a_model.jl

@@ -45,7 +45,7 @@ model = LithiumIonBattery(; model_settings);
 
 # We get a warning that a validation issue has been encountered. For now we ignore it:
 
-cell_parameters_sei = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters_sei = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cccv_protocol = load_cycling_protocol(; from_default_set = "cccv")
 
 try  # hide

examples/beginner_tutorials/6_handle_cell_parameters.jl

@@ -9,7 +9,7 @@
 
 using BattMo
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 nothing # hide
 
@@ -82,7 +82,7 @@ fig
 
 # Let’s reload the original parameters and simulate again to compare:
 
-cell_parameters_2 = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters_2 = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 sim2 = Simulation(model, cell_parameters_2, cycling_protocol);
 output2 = solve(sim2)
 nothing # hide

examples/beginner_tutorials/7_handle_cycling_protocols.jl

@@ -10,7 +10,7 @@ using BattMo, GLMakie, Printf
 
 # Load cell and model setup
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cc_discharge_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 
 # Load default model

examples/beginner_tutorials/8_compute_cell_kpis.jl

@@ -9,7 +9,7 @@
 using BattMo, GLMakie
 
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 nothing # hide
 

examples/beginner_tutorials/9_run_parameter_sweep.jl

@@ -6,7 +6,7 @@
 
 using BattMo, GLMakie
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 nothing # hide
 

examples/example_1d_plotting.jl

@@ -2,7 +2,7 @@ using BattMo, GLMakie
 
 model_settings = load_model_settings(; from_default_set = "p2d")
 model_settings["SEIModel"] = "Bolay"
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cccv")
 simulation_settings = load_simulation_settings(; from_default_set = "p2d")
 

examples/example_3D_cylindrical.jl

@@ -5,7 +5,7 @@
 using BattMo, Jutul, GLMakie
 
 # ## Load the cell parameters
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p4d_cylindrical")
 simulation_settings = load_simulation_settings(; from_default_set = "p4d_cylindrical")
@@ -118,7 +118,7 @@ fig #hide
 
 # We reload the original parameters
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p4d_cylindrical")
 simulation_settings = load_simulation_settings(; from_default_set = "p4d_cylindrical")

examples/example_3D_pouch.jl

@@ -10,7 +10,7 @@ using BattMo, GLMakie, Jutul
 
 # ## Load default parameter sets
 
-cell_parameters = load_cell_parameters(; from_default_set = "xu_2015")
+cell_parameters = load_cell_parameters(; from_default_set = "LP2770120_graphite_LFP_prismatic")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p4d_pouch")
 simulation_settings = load_simulation_settings(; from_default_set = "p4d_pouch")

examples/example_3d_demo.jl

@@ -2,7 +2,7 @@
 using Jutul, BattMo, GLMakie
 
 # ## Setup input parameters
-file_path_cell = parameter_file_path("cell_parameters", "xu_2015.json")
+file_path_cell = parameter_file_path("cell_parameters", "LP2770120_graphite_LFP_prismatic.json")
 file_path_model = parameter_file_path("model_settings", "p4d_pouch.json")
 file_path_cycling = parameter_file_path("cycling_protocols", "cc_discharge.json")
 file_path_simulation = parameter_file_path("simulation_settings", "p4d_pouch.json")

examples/example_Xu2015.jl

@@ -12,7 +12,7 @@ df_2 = CSV.read(string(data_path, "Xu_2015_voltageCurve_2C.csv"), DataFrame)
 
 dfs = [df_05, df_1, df_2]
 
-cell_parameters = load_cell_parameters(; from_default_set = "xu_2015")
+cell_parameters = load_cell_parameters(; from_default_set = "LP2770120_graphite_LFP_prismatic")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 
 model_setup = LithiumIonBattery()

examples/example_arrhenius.jl

@@ -1,7 +1,7 @@
 using BattMo
 using GLMakie
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p2d")
 

examples/example_calibration.jl

@@ -30,7 +30,7 @@ df_2 = CSV.read(joinpath(exdata, "Xu_2015_voltageCurve_2C.csv"), DataFrame)
 
 dfs = [df_05, df_1, df_2]
 
-cell_parameters = load_cell_parameters(; from_default_set = "xu_2015")
+cell_parameters = load_cell_parameters(; from_default_set = "LP2770120_graphite_LFP_prismatic")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 
 cycling_protocol["LowerVoltageLimit"] = 2.25

examples/example_chayambuka.jl

@@ -8,7 +8,7 @@ using BattMo, GLMakie
 
 ######### Load Simulation Data #########
 
-cell_parameters = load_cell_parameters(; from_default_set = "chayambuka_2022")
+cell_parameters = load_cell_parameters(; from_default_set = "HC_NVPF_electrodes")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p2d")
 simulation_settings = load_simulation_settings(; from_default_set = "p2d")

examples/example_cycle.jl

@@ -3,7 +3,7 @@
 using BattMo, GLMakie
 
 # We use the setup provided in the [p2d_40.json](https://github.com/BattMoTeam/BattMo.jl/blob/main/test/data/jsonfiles/p2d_40.json#L152) file. In particular, see the data under the `Control` key.
-file_path_cell = parameter_file_path("cell_parameters", "chen_2020.json")
+file_path_cell = parameter_file_path("cell_parameters", "LG_INR_21700_M50.json")
 file_path_cycling = parameter_file_path("cycling_protocols", "cccv.json")
 
 

examples/example_grid_optimization.jl

@@ -11,7 +11,7 @@ time_profiles = Dict{Int, Vector{Float64}}()
 rel_errors = Dict{Int, Float64}()
 
 # Load base inputs
-cell_parameters = load_cell_parameters(; from_default_set = "chayambuka_2022")
+cell_parameters = load_cell_parameters(; from_default_set = "HC_NVPF_electrodes")
 base_simulation_settings = load_simulation_settings(; from_default_set = "p2d")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 

examples/example_headless.jl

@@ -6,7 +6,7 @@
 
 using BattMo, GLMakie
 
-simulation_input = load_full_simulation_input(; from_default_set = "chen_2020")
+simulation_input = load_full_simulation_input(; from_default_set = "LG_INR_21700_M50")
 
 output = run_simulation(simulation_input)
 

examples/example_initial_state.jl

@@ -13,7 +13,7 @@ rmse(x, y0, y1) = sqrt(trapz(x, (y1 .- y0) .^ 2) / (x[end] - x[1]))
 
 # Setup cell model and parameters
 model = LithiumIonBattery()
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 
 # Step 0: full discharge--charge cycle as reference
 con = Constants()

examples/example_input_current_series.jl

@@ -11,7 +11,7 @@ using BattMo
 ###
 
 model_setup = LithiumIonBattery()
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 model_settings = load_model_settings(; from_default_set = "p2d")
 simulation_settings = load_simulation_settings(; from_default_set = "p2d")
 

examples/example_run_current_function.jl

@@ -28,7 +28,7 @@ end
 
 model_setup = LithiumIonBattery()
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 
 simulation_settings = load_simulation_settings(; from_default_set = "p2d")
 simulation_settings["TimeStepDuration"] = 1

examples/example_sei.jl

@@ -5,7 +5,7 @@ using Jutul, BattMo, GLMakie
 
 # We use the SEI model presented in [bolay2022](@cite). We use the json data given in [bolay.json](https://github.com/BattMoTeam/BattMo.jl/blob/main/test/data/jsonfiles/bolay.json#L157) which contains the parameters for the SEI layer.
 
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cccv")
 simulation_settings = load_simulation_settings(; from_default_set = "p2d")
 

examples/example_thermal.jl

@@ -3,7 +3,7 @@ using Jutul, BattMo, GLMakie, Statistics
 ############# BattMo.jl format
 
 ## Setup input parameters
-cell_parameters = load_cell_parameters(; from_default_set = "xu_2015")
+cell_parameters = load_cell_parameters(; from_default_set = "LP2770120_graphite_LFP_prismatic")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p4d_pouch")
 simulation_settings = load_simulation_settings(; from_default_set = "p4d_pouch")

examples/validation_notebooks/arrhenius.jl

@@ -20,7 +20,7 @@ using GLMakie
 using Statistics
 
 # ### Load model with Arrhenius temperature dependence
-cell_parameters = load_cell_parameters(; from_default_set = "chen_2020")
+cell_parameters = load_cell_parameters(; from_default_set = "LG_INR_21700_M50")
 cycling_protocol = load_cycling_protocol(; from_default_set = "cc_discharge")
 model_settings = load_model_settings(; from_default_set = "p2d")