BLAST-Lite 1.0.0__tar.gz

blast_lite-1.0.0/BLAST_Lite.egg-info/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.1
+Name: BLAST-Lite
+Version: 1.0.0
+Summary: Tool to model lifetime and degradation for commercial lithium-ion batteries.
+Author-email: Paul Gasper <Paul.Gasper@nrel.gov>, Kandler Smith <Kandler.Smith@nrel.gov>
+License: Copyright (c) 2023, Alliance for Sustainable Energy, LLC
+        All rights reserved.
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/NREL/BLAST-Lite
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: <=3.12.4,>=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: h5pyd
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: scipy
+Requires-Dist: nrel-rex
+Requires-Dist: geopy
+Provides-Extra: dev
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: myst-parser; extra == "dev"
+Requires-Dist: sphinx-copybutton; extra == "dev"
+Requires-Dist: pydata-sphinx-theme; extra == "dev"
+Requires-Dist: ipykernel; extra == "dev"
+
+![BLAST-Lite](assets/icon-blast.jpg)
+
+# BLAST-Lite
+Battery Lifetime Analysis and Simulation Toolsuite (BLAST) provides a library of battery lifetime and degradation models for various commercial lithium-ion batteries from recent years. Degradation models are indentified from publically available lab-based aging data using NREL's battery life model identification toolkit. The battery life models predicted the expected lifetime of batteries used in mobile or stationary applications as functions of their temperature and use (state-of-charge, depth-of-discharge, and charge/discharge rates). Model implementation is in both Python and MATLAB programming languages. The MATLAB code also provides example applications (stationary storage and EV), climate data, and simple thermal management options. For more information on battery health diagnostics, prediction, and optimization, see [NREL's Battery Lifespan](https://www.nrel.gov/transportation/battery-lifespan.html) webpage.
+
+![Example battery life predictions](assets/example_battery_life.png)
+
+### Installation
+
+Set up and activate a Python environment (anything between Python 3.8 and 3.12):
+
+```
+conda create -n blast-lite python=3.12
+conda activate blast-lite
+```
+
+Install BLAST-Lite via PyPI.
+In the environment created and activate above, run `pip install blast-lite`.
+
+
+#### Note: Fetching temperature data from NSRDB
+The `blast.utils.get_nsrdb_temperature_data()` function uses an API key to access the NREL NSRDB for climate data for any requested location. If making many requests, please [get your own API key](https://developer.nrel.gov/signup) and replace the existing API key with yours in the 'examples\.hscfg' file. This configuration file is assumed by default to be in your 'home' folder, that is, the same folder as the code that is being run.
+
+If using a Windows machine, you may need to additionally run the following:
+
+`$ python -m pip install python-certifi-win32`.
+
+```python
+import certifi
+import ssl
+import geopy
+
+ctx = ssl.create_default_context(cafile=certifi.where())
+geopy.geocoders.options.default_ssl_context = ctx
+```
+
+
+### Quickstart
+Once the package is installed, you can generate an example usage dataset by running:
+
+```python
+from blast import utils
+data = utils.generate_example_data()
+```
+
+To see a list of available battery models, run:
+```python
+from blast import models
+models.available_models()
+```
+
+Select a model, instantiate a cell, and run the simulation:
+```python
+cell = models.Lfp_Gr_250AhPrismatic()
+cell.simulate_battery_life(data)
+```
+
+### Caveats
+These battery models predict 'expected life', that is, battery life under nominal conditions. Many types of battery failure will not be predicted by these models:
+- Overcharge or overdischarge
+- Impact of physical damage, vibration, or humidity
+- Operating outside of manufacturer performance and environmental limits, such as voltage, temperature, and charge/discharge rate limits
+- Pack performance loss due to cell-to-cell inbalance
+
+Aging models are generally trained on a limited amount of data, that is, there is not enough information to estimate cell-to-cell variability in degradation rates.
+Battery 'warranty life' is generally much more conservative than 'expected life'. 
+These models are estimating cell level degradation, there will be additional performance penalties and caveats for estimating lifetime of battery packs. 
+A good rule-of-thumb is to assume that pack lifetime is 20-30% less than cell lifetime, but please support model simulations with data if you have it.
+
+### Citations
+ - Sony Murata LFP-Gr battery aging data and model
+     - [Calendar aging data source](https://doi.org/10.1016/j.est.2018.01.019)
+     - [Cycle aging data source](https://doi.org/10.1016/j.jpowsour.2019.227666)
+     - [Model identification source](https://doi.org/10.1149/1945-7111/ac86a8)
+ - Nissan Leaf LMO-Gr (2nd life cells) battery aging data
+     - [Calendar aging data source](https://doi.org/10.1109/EEEIC/ICPSEUROPE54979.2022.9854784)
+     - [Cycle aging data source](https://doi.org/10.1016/j.est.2020.101695)
+ - Panasonic NCA-Gr battery aging data
+     - [Calendar aging data source](https://dx.doi.org/10.1149/2.0411609jes)
+     - [Cycle aging data source](https://doi.org/10.1149/1945-7111/abae37)
+ - [Sony Murata NCA-GrSi battery aging data](https://doi.org/10.1016/j.jpowsour.2022.232498)
+     - Additional research by TUM on [mechanistic cycling](https://doi.org/10.1016/j.jpowsour.2023.233947) and [mechanistic calendar aging](https://doi.org/10.1016/j.jpowsour.2023.233208) models is not replicated here
+ - [Commercial NMC-LTO battery aging data source](https://doi.org/10.1016/j.jpowsour.2020.228566)
+ - [Kokam NMC111-Gr battery aging data source](https://ieeexplore.ieee.org/iel7/7951530/7962914/07963578.pdf)
+ - [Sanyo NMC111-Gr battery aging model source](http://dx.doi.org/10.1016/j.jpowsour.2014.02.012)
+ - [LG MJ1 NMC811-GrSi battery aging data source](https://everlasting-project.eu/wp-content/uploads/2020/03/EVERLASTING_D2.3_final_20200228.pdf)
+ - Models of commercially produced (> 1 GWh / yr manufacturers), large format Li-ion cells from a [2023 Journal of Energy Storage paper](https://doi.org/10.1016/j.est.2023.109042)
+    - 250 Ah LFP-Gr (high energy density, very low power)
+    - 75 Ah NMC-Gr 'A' (relatively high power, suitable for fast charging)
+    - 50 Ah NMC-GR 'B1' (relatively high power, suitable for fast charging)
+    - 50 Ah NMC-Gr 'B2' (higher energy density than B1 but lower power, questionable performance and durability under fast charging demands)
+ - Stationary storage battery use profiles are [provided open-source](https://dataserv.ub.tum.de/index.php/s/m1510254) by [Kucevic et al](https://www.sciencedirect.com/science/article/pii/S2352152X19309016)
+ - Electric vehicle battery use profiles were generated using NREL's [FASTSim tool](https://www.nrel.gov/transportation/fastsim.html).
+
+### Authors
+Paul Gasper, Kandler Smith
+
+NREL SWR-22-69

blast_lite-1.0.0/BLAST_Lite.egg-info/SOURCES.txt

@@ -0,0 +1,29 @@
+LICENSE
+NOTICE
+README.md
+pyproject.toml
+BLAST_Lite.egg-info/PKG-INFO
+BLAST_Lite.egg-info/SOURCES.txt
+BLAST_Lite.egg-info/dependency_links.txt
+BLAST_Lite.egg-info/requires.txt
+BLAST_Lite.egg-info/top_level.txt
+blast/__init__.py
+blast/models/__init__.py
+blast/models/_available_models.py
+blast/models/degradation_model.py
+blast/models/lfp_gr_250AhPrismatic_2019.py
+blast/models/lfp_gr_SonyMurata3Ah_2018.py
+blast/models/lmo_gr_NissanLeaf66Ah_2ndLife_2020.py
+blast/models/nca_gr_Panasonic3Ah_2018.py
+blast/models/nca_grsi_SonyMurata2p5Ah_2023.py
+blast/models/nmc111_gr_Kokam75Ah_2017.py
+blast/models/nmc111_gr_Sanyo2Ah_2014.py
+blast/models/nmc811_grSi_LGMJ1_4Ah_2020.py
+blast/models/nmc_gr_50Ah_B1_2020.py
+blast/models/nmc_gr_50Ah_B2_2020.py
+blast/models/nmc_gr_75Ah_A_2019.py
+blast/models/nmc_lto_10Ah_2020.py
+blast/utils/__init__.py
+blast/utils/demo.py
+blast/utils/functions.py
+blast/utils/rainflow.py

blast_lite-1.0.0/BLAST_Lite.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

blast_lite-1.0.0/BLAST_Lite.egg-info/requires.txt

@@ -0,0 +1,14 @@
+h5pyd
+numpy
+pandas
+matplotlib
+scipy
+nrel-rex
+geopy
+
+[dev]
+sphinx
+myst-parser
+sphinx-copybutton
+pydata-sphinx-theme
+ipykernel

blast_lite-1.0.0/BLAST_Lite.egg-info/top_level.txt

@@ -0,0 +1 @@
+blast

blast_lite-1.0.0/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2023, Alliance for Sustainable Energy, LLC
+All rights reserved.
+
+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.

blast_lite-1.0.0/NOTICE

@@ -0,0 +1,5 @@
+NOTICE
+
+BLAST-Python   Copyright ©2022   Alliance for Sustainable Energy, LLC 
+
+These data were produced by the Alliance for Sustainable Energy, LLC (Contractor) under Contract No. DE-AC36-08GO28308 with the U.S. Department of Energy (DOE). During the period of commercialization or such other time period specified by the DOE, the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, and perform publicly and display publicly, by or on behalf of the Government. Subsequent to that period the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. The specific term of the license can be identified by inquiry made to the Contractor or DOE. NEITHER CONTRACTOR, THE UNITED STATES, NOR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LEGAL LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF ANY DATA, APPARATUS, PRODUCT, OR PROCESS DISCLOSED, OR REPRESENTS THAT ITS USE WOULD NOT INFRINGE PRIVATELY OWNED RIGHTS.

blast_lite-1.0.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.1
+Name: BLAST-Lite
+Version: 1.0.0
+Summary: Tool to model lifetime and degradation for commercial lithium-ion batteries.
+Author-email: Paul Gasper <Paul.Gasper@nrel.gov>, Kandler Smith <Kandler.Smith@nrel.gov>
+License: Copyright (c) 2023, Alliance for Sustainable Energy, LLC
+        All rights reserved.
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/NREL/BLAST-Lite
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: <=3.12.4,>=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: h5pyd
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: scipy
+Requires-Dist: nrel-rex
+Requires-Dist: geopy
+Provides-Extra: dev
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: myst-parser; extra == "dev"
+Requires-Dist: sphinx-copybutton; extra == "dev"
+Requires-Dist: pydata-sphinx-theme; extra == "dev"
+Requires-Dist: ipykernel; extra == "dev"
+
+![BLAST-Lite](assets/icon-blast.jpg)
+
+# BLAST-Lite
+Battery Lifetime Analysis and Simulation Toolsuite (BLAST) provides a library of battery lifetime and degradation models for various commercial lithium-ion batteries from recent years. Degradation models are indentified from publically available lab-based aging data using NREL's battery life model identification toolkit. The battery life models predicted the expected lifetime of batteries used in mobile or stationary applications as functions of their temperature and use (state-of-charge, depth-of-discharge, and charge/discharge rates). Model implementation is in both Python and MATLAB programming languages. The MATLAB code also provides example applications (stationary storage and EV), climate data, and simple thermal management options. For more information on battery health diagnostics, prediction, and optimization, see [NREL's Battery Lifespan](https://www.nrel.gov/transportation/battery-lifespan.html) webpage.
+
+![Example battery life predictions](assets/example_battery_life.png)
+
+### Installation
+
+Set up and activate a Python environment (anything between Python 3.8 and 3.12):
+
+```
+conda create -n blast-lite python=3.12
+conda activate blast-lite
+```
+
+Install BLAST-Lite via PyPI.
+In the environment created and activate above, run `pip install blast-lite`.
+
+
+#### Note: Fetching temperature data from NSRDB
+The `blast.utils.get_nsrdb_temperature_data()` function uses an API key to access the NREL NSRDB for climate data for any requested location. If making many requests, please [get your own API key](https://developer.nrel.gov/signup) and replace the existing API key with yours in the 'examples\.hscfg' file. This configuration file is assumed by default to be in your 'home' folder, that is, the same folder as the code that is being run.
+
+If using a Windows machine, you may need to additionally run the following:
+
+`$ python -m pip install python-certifi-win32`.
+
+```python
+import certifi
+import ssl
+import geopy
+
+ctx = ssl.create_default_context(cafile=certifi.where())
+geopy.geocoders.options.default_ssl_context = ctx
+```
+
+
+### Quickstart
+Once the package is installed, you can generate an example usage dataset by running:
+
+```python
+from blast import utils
+data = utils.generate_example_data()
+```
+
+To see a list of available battery models, run:
+```python
+from blast import models
+models.available_models()
+```
+
+Select a model, instantiate a cell, and run the simulation:
+```python
+cell = models.Lfp_Gr_250AhPrismatic()
+cell.simulate_battery_life(data)
+```
+
+### Caveats
+These battery models predict 'expected life', that is, battery life under nominal conditions. Many types of battery failure will not be predicted by these models:
+- Overcharge or overdischarge
+- Impact of physical damage, vibration, or humidity
+- Operating outside of manufacturer performance and environmental limits, such as voltage, temperature, and charge/discharge rate limits
+- Pack performance loss due to cell-to-cell inbalance
+
+Aging models are generally trained on a limited amount of data, that is, there is not enough information to estimate cell-to-cell variability in degradation rates.
+Battery 'warranty life' is generally much more conservative than 'expected life'. 
+These models are estimating cell level degradation, there will be additional performance penalties and caveats for estimating lifetime of battery packs. 
+A good rule-of-thumb is to assume that pack lifetime is 20-30% less than cell lifetime, but please support model simulations with data if you have it.
+
+### Citations
+ - Sony Murata LFP-Gr battery aging data and model
+     - [Calendar aging data source](https://doi.org/10.1016/j.est.2018.01.019)
+     - [Cycle aging data source](https://doi.org/10.1016/j.jpowsour.2019.227666)
+     - [Model identification source](https://doi.org/10.1149/1945-7111/ac86a8)
+ - Nissan Leaf LMO-Gr (2nd life cells) battery aging data
+     - [Calendar aging data source](https://doi.org/10.1109/EEEIC/ICPSEUROPE54979.2022.9854784)
+     - [Cycle aging data source](https://doi.org/10.1016/j.est.2020.101695)
+ - Panasonic NCA-Gr battery aging data
+     - [Calendar aging data source](https://dx.doi.org/10.1149/2.0411609jes)
+     - [Cycle aging data source](https://doi.org/10.1149/1945-7111/abae37)
+ - [Sony Murata NCA-GrSi battery aging data](https://doi.org/10.1016/j.jpowsour.2022.232498)
+     - Additional research by TUM on [mechanistic cycling](https://doi.org/10.1016/j.jpowsour.2023.233947) and [mechanistic calendar aging](https://doi.org/10.1016/j.jpowsour.2023.233208) models is not replicated here
+ - [Commercial NMC-LTO battery aging data source](https://doi.org/10.1016/j.jpowsour.2020.228566)
+ - [Kokam NMC111-Gr battery aging data source](https://ieeexplore.ieee.org/iel7/7951530/7962914/07963578.pdf)
+ - [Sanyo NMC111-Gr battery aging model source](http://dx.doi.org/10.1016/j.jpowsour.2014.02.012)
+ - [LG MJ1 NMC811-GrSi battery aging data source](https://everlasting-project.eu/wp-content/uploads/2020/03/EVERLASTING_D2.3_final_20200228.pdf)
+ - Models of commercially produced (> 1 GWh / yr manufacturers), large format Li-ion cells from a [2023 Journal of Energy Storage paper](https://doi.org/10.1016/j.est.2023.109042)
+    - 250 Ah LFP-Gr (high energy density, very low power)
+    - 75 Ah NMC-Gr 'A' (relatively high power, suitable for fast charging)
+    - 50 Ah NMC-GR 'B1' (relatively high power, suitable for fast charging)
+    - 50 Ah NMC-Gr 'B2' (higher energy density than B1 but lower power, questionable performance and durability under fast charging demands)
+ - Stationary storage battery use profiles are [provided open-source](https://dataserv.ub.tum.de/index.php/s/m1510254) by [Kucevic et al](https://www.sciencedirect.com/science/article/pii/S2352152X19309016)
+ - Electric vehicle battery use profiles were generated using NREL's [FASTSim tool](https://www.nrel.gov/transportation/fastsim.html).
+
+### Authors
+Paul Gasper, Kandler Smith
+
+NREL SWR-22-69

blast_lite-1.0.0/README.md

@@ -0,0 +1,98 @@
+![BLAST-Lite](assets/icon-blast.jpg)
+
+# BLAST-Lite
+Battery Lifetime Analysis and Simulation Toolsuite (BLAST) provides a library of battery lifetime and degradation models for various commercial lithium-ion batteries from recent years. Degradation models are indentified from publically available lab-based aging data using NREL's battery life model identification toolkit. The battery life models predicted the expected lifetime of batteries used in mobile or stationary applications as functions of their temperature and use (state-of-charge, depth-of-discharge, and charge/discharge rates). Model implementation is in both Python and MATLAB programming languages. The MATLAB code also provides example applications (stationary storage and EV), climate data, and simple thermal management options. For more information on battery health diagnostics, prediction, and optimization, see [NREL's Battery Lifespan](https://www.nrel.gov/transportation/battery-lifespan.html) webpage.
+
+![Example battery life predictions](assets/example_battery_life.png)
+
+### Installation
+
+Set up and activate a Python environment (anything between Python 3.8 and 3.12):
+
+```
+conda create -n blast-lite python=3.12
+conda activate blast-lite
+```
+
+Install BLAST-Lite via PyPI.
+In the environment created and activate above, run `pip install blast-lite`.
+
+
+#### Note: Fetching temperature data from NSRDB
+The `blast.utils.get_nsrdb_temperature_data()` function uses an API key to access the NREL NSRDB for climate data for any requested location. If making many requests, please [get your own API key](https://developer.nrel.gov/signup) and replace the existing API key with yours in the 'examples\.hscfg' file. This configuration file is assumed by default to be in your 'home' folder, that is, the same folder as the code that is being run.
+
+If using a Windows machine, you may need to additionally run the following:
+
+`$ python -m pip install python-certifi-win32`.
+
+```python
+import certifi
+import ssl
+import geopy
+
+ctx = ssl.create_default_context(cafile=certifi.where())
+geopy.geocoders.options.default_ssl_context = ctx
+```
+
+
+### Quickstart
+Once the package is installed, you can generate an example usage dataset by running:
+
+```python
+from blast import utils
+data = utils.generate_example_data()
+```
+
+To see a list of available battery models, run:
+```python
+from blast import models
+models.available_models()
+```
+
+Select a model, instantiate a cell, and run the simulation:
+```python
+cell = models.Lfp_Gr_250AhPrismatic()
+cell.simulate_battery_life(data)
+```
+
+### Caveats
+These battery models predict 'expected life', that is, battery life under nominal conditions. Many types of battery failure will not be predicted by these models:
+- Overcharge or overdischarge
+- Impact of physical damage, vibration, or humidity
+- Operating outside of manufacturer performance and environmental limits, such as voltage, temperature, and charge/discharge rate limits
+- Pack performance loss due to cell-to-cell inbalance
+
+Aging models are generally trained on a limited amount of data, that is, there is not enough information to estimate cell-to-cell variability in degradation rates.
+Battery 'warranty life' is generally much more conservative than 'expected life'. 
+These models are estimating cell level degradation, there will be additional performance penalties and caveats for estimating lifetime of battery packs. 
+A good rule-of-thumb is to assume that pack lifetime is 20-30% less than cell lifetime, but please support model simulations with data if you have it.
+
+### Citations
+ - Sony Murata LFP-Gr battery aging data and model
+     - [Calendar aging data source](https://doi.org/10.1016/j.est.2018.01.019)
+     - [Cycle aging data source](https://doi.org/10.1016/j.jpowsour.2019.227666)
+     - [Model identification source](https://doi.org/10.1149/1945-7111/ac86a8)
+ - Nissan Leaf LMO-Gr (2nd life cells) battery aging data
+     - [Calendar aging data source](https://doi.org/10.1109/EEEIC/ICPSEUROPE54979.2022.9854784)
+     - [Cycle aging data source](https://doi.org/10.1016/j.est.2020.101695)
+ - Panasonic NCA-Gr battery aging data
+     - [Calendar aging data source](https://dx.doi.org/10.1149/2.0411609jes)
+     - [Cycle aging data source](https://doi.org/10.1149/1945-7111/abae37)
+ - [Sony Murata NCA-GrSi battery aging data](https://doi.org/10.1016/j.jpowsour.2022.232498)
+     - Additional research by TUM on [mechanistic cycling](https://doi.org/10.1016/j.jpowsour.2023.233947) and [mechanistic calendar aging](https://doi.org/10.1016/j.jpowsour.2023.233208) models is not replicated here
+ - [Commercial NMC-LTO battery aging data source](https://doi.org/10.1016/j.jpowsour.2020.228566)
+ - [Kokam NMC111-Gr battery aging data source](https://ieeexplore.ieee.org/iel7/7951530/7962914/07963578.pdf)
+ - [Sanyo NMC111-Gr battery aging model source](http://dx.doi.org/10.1016/j.jpowsour.2014.02.012)
+ - [LG MJ1 NMC811-GrSi battery aging data source](https://everlasting-project.eu/wp-content/uploads/2020/03/EVERLASTING_D2.3_final_20200228.pdf)
+ - Models of commercially produced (> 1 GWh / yr manufacturers), large format Li-ion cells from a [2023 Journal of Energy Storage paper](https://doi.org/10.1016/j.est.2023.109042)
+    - 250 Ah LFP-Gr (high energy density, very low power)
+    - 75 Ah NMC-Gr 'A' (relatively high power, suitable for fast charging)
+    - 50 Ah NMC-GR 'B1' (relatively high power, suitable for fast charging)
+    - 50 Ah NMC-Gr 'B2' (higher energy density than B1 but lower power, questionable performance and durability under fast charging demands)
+ - Stationary storage battery use profiles are [provided open-source](https://dataserv.ub.tum.de/index.php/s/m1510254) by [Kucevic et al](https://www.sciencedirect.com/science/article/pii/S2352152X19309016)
+ - Electric vehicle battery use profiles were generated using NREL's [FASTSim tool](https://www.nrel.gov/transportation/fastsim.html).
+
+### Authors
+Paul Gasper, Kandler Smith
+
+NREL SWR-22-69

blast_lite-1.0.0/blast/__init__.py

@@ -0,0 +1,4 @@
+from . import models
+from . import utils
+
+__all__ = ["models", "utils"]

blast_lite-1.0.0/blast/models/__init__.py

@@ -0,0 +1,17 @@
+from .degradation_model import BatteryDegradationModel
+from .lfp_gr_250AhPrismatic_2019 import Lfp_Gr_250AhPrismatic
+from .lfp_gr_SonyMurata3Ah_2018 import Lfp_Gr_SonyMurata3Ah_Battery
+from .lmo_gr_NissanLeaf66Ah_2ndLife_2020 import Lmo_Gr_NissanLeaf66Ah_2ndLife_Battery
+from .nca_grsi_SonyMurata2p5Ah_2023 import NCA_GrSi_SonyMurata2p5Ah_Battery
+from .nca_gr_Panasonic3Ah_2018 import Nca_Gr_Panasonic3Ah_Battery
+from .nmc111_gr_Kokam75Ah_2017 import Nmc111_Gr_Kokam75Ah_Battery
+from .nmc111_gr_Sanyo2Ah_2014 import Nmc111_Gr_Sanyo2Ah_Battery
+from .nmc811_grSi_LGMJ1_4Ah_2020 import Nmc811_GrSi_LGMJ1_4Ah_Battery
+from .nmc_gr_50Ah_B1_2020 import NMC_Gr_50Ah_B1
+from .nmc_gr_50Ah_B2_2020 import NMC_Gr_50Ah_B2
+from .nmc_gr_75Ah_A_2019 import NMC_Gr_75Ah_A
+from .nmc_lto_10Ah_2020 import Nmc_Lto_10Ah_Battery
+
+from ._available_models import available_models
+
+__all__ = ['BatteryDegradationModel', 'Lfp_Gr_250AhPrismatic', 'Lfp_Gr_SonyMurata3Ah_Battery', 'Lmo_Gr_NissanLeaf66Ah_2ndLife_Battery', 'NCA_GrSi_SonyMurata2p5Ah_Battery', 'NMC_Gr_50Ah_B1', 'NMC_Gr_50Ah_B2', 'NMC_Gr_75Ah_A', 'Nca_Gr_Panasonic3Ah_Battery', 'Nmc111_Gr_Kokam75Ah_Battery', 'Nmc111_Gr_Sanyo2Ah_Battery', 'Nmc811_GrSi_LGMJ1_4Ah_Battery', 'Nmc_Lto_10Ah_Battery', '_available_models']

blast_lite-1.0.0/blast/models/_available_models.py

@@ -0,0 +1,9 @@
+import sys, inspect
+
+
+def available_models():
+    """
+    Return list of names of available models.
+    """
+    clsmembers = inspect.getmembers(sys.modules['blast.models'], inspect.isclass)
+    return [cls[0] for cls in clsmembers if cls[0] != 'BatteryDegradationModel']