Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Please include a summary of the change and which issue is fixed. Please also inc
Fixes # (issue)

## Type of change
Please add a line in the relevant section of [CHANGELOG.md](https://github.com/NREL/BATMODS-lite/blob/main/CHANGELOG.md) to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.
Please add a line in the relevant section of [CHANGELOG.md](https://github.com/NatLabRockies/BATMODS-lite/blob/main/CHANGELOG.md) to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

- [ ] New feature (non-breaking change which adds functionality)
- [ ] Optimization (back-end change that improves speed/readability/etc.)
Expand Down
19 changes: 10 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# BATMODS Changelog

## [Unreleased](https://github.com/NREL/BATMODS-lite/)
## [Unreleased](https://github.com/NatLabRockies/BATMODS-lite/)

### New Features
- Check bounds of intercalation fraction before calculating exchange current density ([#19](https://github.com/NREL/BATMODS-lite/pull/19))
- Update `materials` module with new LFP properties, from ICI ([#18](https://github.com/NREL/BATMODS-lite/pull/18))
- Use `CubicSpline` interpolations for LFP properties ([#15](https://github.com/NREL/BATMODS-lite/pull/15))
- Add degradation parameters for the electrolyte (applies to P2D only) ([#14](https://github.com/NREL/BATMODS-lite/pull/14))
- Add `submodels` modules with optional `Hysteresis` class, and directional `Ds` / `i0` ([#13](https://github.com/NREL/BATMODS-lite/pull/13))
- Check bounds of intercalation fraction before calculating exchange current density ([#19](https://github.com/NatLabRockies/BATMODS-lite/pull/19))
- Update `materials` module with new LFP properties, from ICI ([#18](https://github.com/NatLabRockies/BATMODS-lite/pull/18))
- Use `CubicSpline` interpolations for LFP properties ([#15](https://github.com/NatLabRockies/BATMODS-lite/pull/15))
- Add degradation parameters for the electrolyte (applies to P2D only) ([#14](https://github.com/NatLabRockies/BATMODS-lite/pull/14))
- Add `submodels` modules with optional `Hysteresis` class, and directional `Ds` / `i0` ([#13](https://github.com/NatLabRockies/BATMODS-lite/pull/13))
- `Exerpiment` class interface allows for multi-step and dynamic load profiles
- Simplified `run` and `run_step` methods to work with generalized `Experiment` class
- New solver now provides additional statistics, e.g., number of function and Jacobian evaluations
- Control-specific `Solution` classes are replaced with generalized `StepSolution` and `CycleSolution`

### Optimizations
- Reduce memory usage by delaying post-processing (slicing) steps ([#17](https://github.com/NREL/BATMODS-lite/pull/17))
- Reduce memory usage by delaying post-processing (slicing) steps ([#17](https://github.com/NatLabRockies/BATMODS-lite/pull/17))
- Replaced `scikits-odes` solver with `scikit-sundae` to improve installation
- Sped up SPM by flipping cathode pointers so that bandwidth is reduced to +/- 2
- Use a generic `bandwidth` function instead of having one per model subpackage
Expand All @@ -27,9 +27,10 @@ None.
- Renamed some attributes so they are no longer user-facing (`_sv0`, `_algidx`, etc.)

### Chores
- Rebrand NREL to NLR, and include name change for Alliance as well ([#20](https://github.com/NREL/batmods-lite/pull/20))
- Make GitHub hyperlinks reference new org name `NREL` -> `NatLabRockies` ([#21](https://github.com/NatLabRockies/batmods-lite/pull/21))
- Rebrand NREL to NLR, and include name change for Alliance as well ([#20](https://github.com/NatLabRockies/batmods-lite/pull/20))

## [v0.0.1](https://github.com/NREL/BATMODS-lite/tree/v0.0.1)
## [v0.0.1](https://github.com/NatLabRockies/BATMODS-lite/tree/v0.0.1)
This is the first release of BATMODS-lite. Main features/capabilities are listed below.

### Features
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- <img alt='Logo' style='width: 75%; min-width: 250px; max-width: 500px;'
src='https://github.com/NREL/batmods-lite/blob/main/images/dark.png?raw=true#gh-dark-mode-only'/>
src='https://github.com/NatLabRockies/batmods-lite/blob/main/images/dark.png?raw=true#gh-dark-mode-only'/>
<img alt='Logo' style='width: 75%; min-width: 250px; max-width: 500px;'
src='https://github.com/NREL/batmods-lite/blob/main/images/light.png?raw=true#gh-light-mode-only'/> -->
src='https://github.com/NatLabRockies/batmods-lite/blob/main/images/light.png?raw=true#gh-light-mode-only'/> -->

# BATMODS-lite

Expand All @@ -10,11 +10,11 @@
![coverage][cov-b] &nbsp;
[![pep8][pep-b]][pep-l]

[ci-b]: https://github.com/NREL/batmods-lite/actions/workflows/ci.yml/badge.svg
[ci-l]: https://github.com/NREL/batmods-lite/actions/workflows/ci.yml
[ci-b]: https://github.com/NatLabRockies/batmods-lite/actions/workflows/ci.yml/badge.svg
[ci-l]: https://github.com/NatLabRockies/batmods-lite/actions/workflows/ci.yml

[test-b]: https://github.com/NREL/batmods-lite/blob/main/images/tests.svg?raw=true
[cov-b]: https://github.com/NREL/batmods-lite/blob/main/images/coverage.svg?raw=true
[test-b]: https://github.com/NatLabRockies/batmods-lite/blob/main/images/tests.svg?raw=true
[cov-b]: https://github.com/NatLabRockies/batmods-lite/blob/main/images/coverage.svg?raw=true

[pep-b]: https://img.shields.io/badge/code%20style-pep8-orange.svg
[pep-l]: https://www.python.org/dev/peps/pep-0008
Expand All @@ -37,7 +37,7 @@ pip install -e .[dev] (editable installation with developer options)

The editable installation is useful if you plan to make changes to your local package. It ensures that any changes are immediately available each time the package is imported, without needing to reinstall. The developer options will likely be helpful if you are modifying the package.

If you run into issues with installation due to the [scikit-sundae](https://github.com/NREL/scikit-sundae) dependency, please submit an issue [here](https://github.com/NREL/scikit-sundae/issues). We also manage this solver package, but distribute it separately since it is not developed in pure Python.
If you run into issues with installation due to the [scikit-sundae](https://github.com/NatLabRockies/scikit-sundae) dependency, please submit an issue [here](https://github.com/NatLabRockies/scikit-sundae/issues). We also manage this solver package, but distribute it separately since it is not developed in pure Python.

## Get Started
The API is organized around three main classes that allow you to construct simulations, define experiments, and interact with solutions. Two basic examples are given below. These demonstrate a 2C discharge for both the single particle model (SPM) and pseudo-2D (P2D) model. Note that the experiment class interfaces with all simulations. The simulations and their respective solutions, however, will depend on the model subpackage they are loaded from. For a more detailed tutorial, please check `docs/source/examples`. If you installed the editable version with developer options, you can also build the documentation locally using `nox -s docs`.
Expand Down Expand Up @@ -76,23 +76,23 @@ soln.simple_plot('time_s', 'voltage_V')
## Citing this Work
This work was authored by researchers at the National Laboratory of the Rockies (NLR). If you use this package in your work, please include the following citation:

> Randall, Corey R. "BATMODS-lite: Packaged battery models and material properties [SWR-25-108]." Computer software, Jun. 2025. url: [github.com/NREL/batmods-lite](https://github.com/NREL/batmods-lite). doi: [10.11578/dc.20260114.1](https://doi.org./10.11578/dc.20260114.1).
> Randall, Corey R. "BATMODS-lite: Packaged battery models and material properties [SWR-25-108]." Computer software, Jun. 2025. url: [github.com/NatLabRockies/batmods-lite](https://github.com/NatLabRockies/batmods-lite). doi: [10.11578/dc.20260114.1](https://doi.org./10.11578/dc.20260114.1).

For convenience, we also provide the following for your BibTex:

```
@misc{randall2025bmlite,
author = {Randall, Corey R.},
title = {{BATMODS-lite: Packaged battery models and material properties [SWR-25-108]}},
url = {github.com/NREL/batmods-lite},
url = {github.com/NatLabRockies/batmods-lite},
month = {Jun.},
year = {2025},
doi = {10.11578/dc.20260114.1},
}
```

## Contributing
If you'd like to contribute to this package, please look through the existing [issues](https://github.com/NREL/batmods-lite/issues). If the bug you've caught or the feature you'd like to add isn't already being worked on, please submit a new issue before getting started.
If you'd like to contribute to this package, please look through the existing [issues](https://github.com/NatLabRockies/batmods-lite/issues). If the bug you've caught or the feature you'd like to add isn't already being worked on, please submit a new issue before getting started.

<!-- You should also read through the [developer guidelines](https://batmods-lite.readthedocs.io/latest/development). Need to get on readthedocs first... -->

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
'icon_links': [
{
'name': 'GitHub',
'url': 'https://github.com/NREL/BATMODS-lite',
'url': 'https://github.com/NatLabRockies/BATMODS-lite',
'icon': 'fa-brands fa-github',
},
# {
Expand Down
10 changes: 5 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ description = "Packaged battery models and material properties."
keywords = ["battery", "models", "lithium", "NMC", "LFP"]
authors = [
{ name = "Corey R. Randall" },
{ email = "corey.randall@nrel.gov" },
{ email = "corey.r.randall@gmail.com" },
]
maintainers = [
{ name = "Corey R. Randall" },
{ email = "corey.randall@nrel.gov" },
{ email = "corey.r.randall@gmail.com" },
]
classifiers = [
"Development Status :: 4 - Beta",
Expand Down Expand Up @@ -76,7 +76,7 @@ dev = [


[project.urls]
Homepage = "https://github.com/NREL/BATMODS-lite"
Homepage = "https://github.com/NatLabRockies/BATMODS-lite"
Documentation = "https://batmods-lite.readthedocs.io/"
Repository = "https://github.com/NREL/BATMODS-lite"
Issues = "https://github.com/NREL/BATMODS-lite/issues"
Repository = "https://github.com/NatLabRockies/BATMODS-lite"
Issues = "https://github.com/NatLabRockies/BATMODS-lite/issues"