Releases: BattMoTeam/PyBattMo
Releases · BattMoTeam/PyBattMo
v0.2.3
v0.2.2
What's Changed
- Quicker battmo import by @LorenaH84 in #6
- Fix Makie.jl plotting behaviour within script and notebook environments, solves #4 by @LorenaH84 in #7
Full Changelog: v0.2.1...v0.2.2
v0.2.1
What's Changed
- update to BattMo.jl v0.2.3 by @LorenaH84 in #3
Tools
print_info: replaces the following printing tools:print_output_overview,print_parameter_info, print_setting_info,print_output_variable_info,print_calibration_overview`. Has multiple method to print info about certain objectsquick_cell_check: replacesprint_cell_info
Full Changelog: v0.2.0...v0.2.1
v0.2.0
This is version 0.2, the first in the 0.2 series. This version represents BattMo.jl v0.2.1.
Full Changelog: v0.1.2...v0.2.0
Breaking changes
The output quantities are retrieved differently. They can now be directly extracted from the output structure, example:
output = solve(sim)
time = output.time_series["Time"]
electrolyte_concentration = output.states["ElectrolyteConcentration"]
round_trip_efficiency = output.metrics["RoundTripEfficiency"]
Additional features
Parameter types
SolverSettings: settings that configure the solver and verbosityFullSimulationInput: full parameter and setting simulation input
Load parameters
load_solver_settingsload_full_simulation_input
Expose functions
- expose python functions to the Julia Main space so that BattMo.jl can see them:
expose_to_battmo
Models
SodiumIonBattery
Output handling
- convert output dict (output.time series, output.states, or output.metrics) to pandas dataframe:
to_pandas print_output_overview
Run a simulation
- run simulation wrapper accepting the full simulation input:
run_simulation
Tools
print_cell_infoplot_cell_curves
Plotting
- plot a dashboard with current, voltage and concentration and potential:
plot_dashboard - flexible plot creating using strings:
plot_output - plot interactive 3d results:
plot_interactive_3d
Fixed bugs
- In the previous release it was not possible to pass python functions as functional input parameter. This is been fixed in this release.
v0.1.2
API represents BattMo.jl v0.1.15
Parameter types
CellParameters: parameters that represent the physical cell. Geometry, materials, interphase, etc.CyclingProtocol: parameter that describe the load of the cell.ModelSettings: settings that configure the model describing which sub-models should be used during the simulation.SimulationSettings: settings that configure the simulation. For example, the grid and time resolutions.
Load parameters
- load cell parameters:
load_cell_parameters - load_cycling_protocol:
load_cycling_protocol - load_model_settings:
load_model_settings - load_simulation_settings:
load_simulation_settings
Setup and solve a simulation
- setup model:
LithiumIonBattery - setup a simulation:
Simulation - solve a simulation:
solve
Setup and solve a voltage calibration
- setup a calibration:
VoltageCalibration - free parameters to calibrate:
free_calibration_parameter - print an overview:
print_calibration_overview
Output handling
- retrieve time series quantities:
get_output_time_series - retrieve state quantities:
get_output_states - retrieve metric quantities:
get_output_metrics - print an overview:
print_output_overview
Tools
print_submodels_infoprint_default_input_sets_infoprint_parameter_infoprint_setting_infoprint_output_variable_infogenerate_default_parameter_filesgenerate_default_parameter_files
Full Changelog: v0.1.2...v0.1.2