batmods-lite 0.0.2__py3-none-any.whl

batmods_lite-0.0.2.dist-info/METADATA

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: batmods-lite
+Version: 0.0.2
+Summary: Packaged battery models and material properties.
+Author: Corey R. Randall
+Author-email: corey.r.randall@gmail.com
+Maintainer: Corey R. Randall
+Maintainer-email: corey.r.randall@gmail.com
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/NatLabRockies/batmods-lite
+Project-URL: Documentation, https://batmods-lite.readthedocs.io/
+Project-URL: Repository, https://github.com/NatLabRockies/batmods-lite
+Project-URL: Issues, https://github.com/NatLabRockies/batmods-lite/issues
+Keywords: battery,models,lithium,NMC,LFP,SPM,P2D
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <3.15,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tqdm
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: pandas
+Requires-Dist: openpyxl
+Requires-Dist: matplotlib
+Requires-Dist: ruamel.yaml
+Requires-Dist: scikit-sundae>=1.1.3
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: myst-nb; extra == "docs"
+Requires-Dist: sphinx-design; extra == "docs"
+Requires-Dist: sphinx-autoapi; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: pydata-sphinx-theme; extra == "docs"
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest-html; extra == "tests"
+Requires-Dist: pytest-xdist; extra == "tests"
+Provides-Extra: dev
+Requires-Dist: nox; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: codespell; extra == "dev"
+Requires-Dist: batmods-lite[docs,tests]; extra == "dev"
+Dynamic: license-file
+
+<!-- <img alt='Logo' style='width: 75%; min-width: 250px; max-width: 500px;' 
+ 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/NatLabRockies/batmods-lite/blob/main/images/light.png?raw=true#gh-light-mode-only'/> -->
+
+# BATMODS-lite
+
+[![ci](https://github.com/NatLabRockies/batmods-lite/actions/workflows/ci.yml/badge.svg)](https://github.com/NatLabRockies/batmods-lite/actions/workflows/ci.yml) &nbsp;
+[![license](https://img.shields.io/badge/license-BSD--3-blue.svg)](https://github.com/NatLabRockies/batmods-lite/blob/main/LICENSE) &nbsp;
+[![codecov](https://codecov.io/gh/NatLabRockies/batmods-lite/graph/badge.svg?token=MPuSOeIurf)](https://codecov.io/gh/NatLabRockies/batmods-lite) &nbsp;
+[![pypi](https://img.shields.io/pypi/v/batmods-lite)](https://pypi.org/project/batmods-lite) &nbsp;
+<!-- [![downloads](https://static.pepy.tech/personalized-badge/batmods-lite?period=total&units=INTERNATIONAL_SYSTEM&left_color=GREY&right_color=BRIGHTGREEN&left_text=pypi|downloads)](https://pepy.tech/projects/batmods-lite)  -->
+
+## Summary
+Battery Analysis and Training Models for Optimization and Design Studies (BATMODS) is a Python package with an API for pre-built battery models. The original purpose of the package was to quickly generate synthetic data for machine learning models to train with. However, the models are generally useful for any battery simulations or analysis. `BATMODS-lite` includes the following: 
+
+1) A library and API for pre-built battery models
+2) Kinetic/transport properties for common battery materials
+
+Note that the package focuses on phsics-based models like the single-particle (SPM) and pseudo-2D (P2D) model. If you enjoy the interface but are looking to run equivalent circuit models (ECMs), you should check out [thevenin](https://github.com/NatLabRockies/thevenin), which is distributed separately, but is developed and maintained by the same team. Consequently, the interface to `thevenin` models is intentionally similar, allowing for a smooth transition between physics-based and ECM approaches.
+
+## Installation
+`BATMODS-lite` can be installed from [PyPI](https://pypi.org/project/batmods-lite) using the following command:
+
+```
+pip install batmods-lite
+```
+
+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.
+
+For those interested in setting up a developer and/or editable version of this software, please see the directions available in the "Development" section of our [documentation](https://batmods-lite.readthedocs.io/en/latest/development).
+
+## 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 more detailed examples, check out the [documentation](https://batmods-lite.readthedocs.io) on Read the Docs. Note that while the full name of the package is `batmods-lite`, the installed module is imported using `bmlite`.
+
+```python
+# Single particle model example
+import bmlite as bm
+
+sim = bm.SPM.Simulation()
+
+expr = bm.Experiment()
+expr.add_step('current_C', 2., (1350., 10.))
+
+soln = sim.run(expr)
+soln.simple_plot('time_s', 'voltage_V')
+```
+
+```python
+# Pseudo-2D model example
+import bmlite as bm
+
+sim = bm.P2D.Simulation()
+
+expr = bm.Experiment()
+expr.add_step('current_C', 2., (1350., 10.))
+
+soln = sim.run(expr)
+soln.simple_plot('time_s', 'voltage_V')
+```
+
+**Notes:**
+* If you are new to Python, check out [Spyder IDE](https://www.spyder-ide.org/). Spyder is a powerful interactive development environment (IDE) that can make programming in Python more approachable to new users.
+* Another friendly option for getting started in Python is to use [Jupyter Notebooks](https://jupyter.org/). We write our examples in Jupyter Notebooks since they support both markdown blocks for explanations and executable code blocks.
+* Python, Spyder, and Jupyter Notebooks can be setup using [Anaconda](https://www.anaconda.com/download/success). Anaconda provides a convenient way for new users to get started with Python due to its friendly graphical installer and environment manager.
+
+## 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/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/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/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... -->
+
+## Disclaimer
+This work was authored by the National Laboratory of the Rockies (NLR), operated by Alliance for Energy Innovation, LLC, for the U.S. Department of Energy (DOE). The views expressed in the repository do not necessarily represent the views of the DOE or the U.S. Government.

batmods_lite-0.0.2.dist-info/RECORD

@@ -0,0 +1,47 @@
+batmods_lite-0.0.2.dist-info/licenses/LICENSE,sha256=9MUmv5W6vPUhzCzvWrHUjB9OqrClwD814_bh5NEVFJw,1522
+bmlite/__init__.py,sha256=Nk7xa7tXospPeW55tdZFcFIN6_mR7sCD40Io2_oApK0,1385
+bmlite/_utils.py,sha256=5g5NkQTTMUc7yxVCc4kCRKOU-I5hWTHs3u50N3-2EV8,6143
+bmlite/mathutils.py,sha256=q6b-dCAzL1CD5-xITqwFcSSDH6hi-IsgAACdZTl6MQM,7338
+bmlite/mesh.py,sha256=Z-k7pY92LbKFqMx8A2x4J_43lmwobFkgcXuRgzkVjgY,6957
+bmlite/P2D/__init__.py,sha256=D0vr5uz7-ftSBJF-1NOXZz63JYR9eBN7dQ13hENpyKc,571
+bmlite/P2D/_simulation.py,sha256=DC6lJtI85qGtVIIMXOT9D0H7RziYuVTeUwntXIKiRzI,15317
+bmlite/P2D/_solutions.py,sha256=kocMA_Dany1jJjomc90IMk5J8kqjaF-9TIx2fVXvAfE,22718
+bmlite/P2D/dae.py,sha256=BDRywCkglon3SyaJ29rLS1LB0I0FXfxHS2_gkdasxkA,12535
+bmlite/P2D/domains.py,sha256=-14gC3YWYliDJHZ8ZA58-bb5miZt1nkT5CZn-YFJIP8,21868
+bmlite/P2D/postutils.py,sha256=T5LUhNYh0-aBHpkOGeT36nimFSChVtlB5aZDIxMlALA,14475
+bmlite/P2D/submodels.py,sha256=FOzb7S2y__mbAht8zrWthfgKp58mrxSmcnGtK3briZg,4536
+bmlite/P2D/templates/graphiteSiOx_nmc811.yaml,sha256=sfTUSQe1Y-8fFi14PnEIYi4wHaV90Aa72DbxhiVCsr0,3608
+bmlite/P2D/templates/graphite_lfp.yaml,sha256=Y9SE5kwf9Mq0RFSh5CnB8TE-f0DCXXObBlSUKvpelvQ,3780
+bmlite/P2D/templates/graphite_nmc532.yaml,sha256=5oStzzzjGkO--YBZHaPvMsoUnss8mBQXCTJ1v5VjtRY,3698
+bmlite/SPM/__init__.py,sha256=ggVZAxsUahzRsVdgwxF_1esgdpqR3FZoB7kC_2ynDIU,577
+bmlite/SPM/_simulation.py,sha256=f3riu19464Ss3DMJv08z-xlSLk5rMsKkt4eZqx7fDn0,15019
+bmlite/SPM/_solutions.py,sha256=35tdzrZEj2zxHmBOkUFjO0i9GP8ADaWy3aKOVyK0pxo,18167
+bmlite/SPM/dae.py,sha256=8ijNYDXPU1nOpWSZsSbdNzgVEWcgsQTXENQZf2bZ_O8,6645
+bmlite/SPM/domains.py,sha256=fzOzTB9cM6k-wXSglwJlv28V0irS4--xGyIwl38N6Eo,14378
+bmlite/SPM/postutils.py,sha256=BF-eh392_FVDf-PpQxhIrt3jmKtyY8QMxn5CPteQjyA,7378
+bmlite/SPM/submodels.py,sha256=lnWTPpI9gvpV7cRAopuSOBcXv7FNpAd1YBBYW59eLhI,4552
+bmlite/SPM/templates/graphiteSiOx_nmc811.yaml,sha256=WArz0s-1_BeWte38gOuH89UsTH29t6nZl2QP9lxm30k,2411
+bmlite/SPM/templates/graphite_lfp.yaml,sha256=rJO3w1SH9xtkPgG8OOm1f8D0VI8iC3nbVliC0kLPg0Y,2553
+bmlite/SPM/templates/graphite_nmc532.yaml,sha256=5C4tWom6NMwnDYDabDTX19O_FFoE25O18GzSd8dlAcc,2471
+bmlite/_core/__init__.py,sha256=PbyVsjsOfcVqc4-0Rf6v_GvN4GKeOagpKbKC5rzXXL0,381
+bmlite/_core/_constants.py,sha256=0gsUDzUtjrwG-2MpQTTZjSerO5RJmtXEBS9r_zmHiPo,318
+bmlite/_core/_experiment.py,sha256=aig-47Y8MnOBG9wXHdM9dZGpBeAydHWKcKHDUCqwuc0,9604
+bmlite/_core/_idasolver.py,sha256=D4gMHyrHTZ9-C5wqEFAQZgo1r58SDb03Q686Q7Rk8VY,3057
+bmlite/_core/_templates.py,sha256=77Xv24cfPrJ1_WLyqzYpu2AGXgdr9qG_-cJyZcOooys,1564
+bmlite/materials/__init__.py,sha256=iNkEm-K00ul2QFked0_f-z0ghzEqX3qOw9SdBDMB-tI,733
+bmlite/materials/_gen2_electrolyte.py,sha256=kMwld4cEqYHp4feiIgnD2Zt0F_41HToKlgvNeNDIzYw,3982
+bmlite/materials/_graphite.py,sha256=0pdCWgTNcpXewQU0_DHFxfzrxKysz-A-xFZ-5Z6SFnI,11219
+bmlite/materials/_graphite_SiOx.py,sha256=GUqnBs1mfBE76kt4K05pEjeuchqc9qP0gQZfIG09rFA,8841
+bmlite/materials/_lfp.py,sha256=M9ADIXwPub6IP1cIRQbqcC5X2JqHXvoXvI8llzIpk94,5103
+bmlite/materials/_nmc_532.py,sha256=zeQI0GhIcvlbfAKyTo-cXctFb6UaSjIk8kJnbnzbtSk,9163
+bmlite/materials/_nmc_811.py,sha256=FQnNdMmv21yc5PE5KDCIMTk2aSNI0ByoSMeZUuqyYCA,8651
+bmlite/materials/data/graphite_ocv.csv,sha256=hf0lIGPxseYSIOBEsamBn7hSQZCnap9B4M0c96NMrOc,4597
+bmlite/materials/data/graphite_ocv_extrap.csv,sha256=d-OuWJKNVkpK-YsngeWOakVjxH8b9PS5fBHM2vB14b0,4606
+bmlite/materials/data/lfp_ocv.csv,sha256=zphYulpEkaFPaFPEpgrJs_1i1i-HmYzWMbaEGKTkuvI,14914
+bmlite/materials/data/nmc532_ocv.csv,sha256=TbKLVZhjb8LToBDDnPtu2nXUe6hRkiXkCA_ptKCkV7w,4580
+bmlite/materials/data/nmc532_ocv_extrap.csv,sha256=oS6tU37DLejqFG41daDb2PBtpfIlC345KPaEcMSEjWY,4664
+bmlite/plotutils/__init__.py,sha256=iwfcbMoz0w_uRSd2KQooWcKoI-kK_uJOnEj3FCoXu3Y,1997
+batmods_lite-0.0.2.dist-info/METADATA,sha256=x5bAjiJO-BwMrTwxDnHyCy-WL6Zd8K1WSK458Our_6Y,8340
+batmods_lite-0.0.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+batmods_lite-0.0.2.dist-info/top_level.txt,sha256=SbSEgKVZa-2ONs4Tzxs5tz_UNwurP6yVih-etjSJWVk,7
+batmods_lite-0.0.2.dist-info/RECORD,,

batmods_lite-0.0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

batmods_lite-0.0.2.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Alliance for Energy Innovation, LLC
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

batmods_lite-0.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+bmlite

bmlite/P2D/__init__.py

@@ -0,0 +1,25 @@
+"""
+A packaged pseudo-2D (P2D) model. Build a model using the `Simulation` class,
+and run an experiment using either the `run()` or `run_step()` methods. These
+methods return `Solution` class instances with post processing, plotting, and
+saving methods.
+
+"""
+
+from ._simulation import Simulation
+from ._solutions import StepSolution, CycleSolution
+
+from . import dae
+from . import domains
+from . import postutils
+from . import submodels
+
+__all__ = [
+    'Simulation',
+    'StepSolution',
+    'CycleSolution',
+    'dae',
+    'domains',
+    'postutils',
+    'submodels',
+]