December 2023
Source code for modeling battery formation.
This work is published in the Journal of the Electrochemical Society here.
The code runs on Python 3.8.8.
-
Clone this repository.
-
Make sure you have Python 3.8.8 installed. Another version of Python will probably work, but no guarantees!
-
Set up your Python virtual environment
- Make sure you're in the root directory of the repo
- Create the virtual environment:
python -m venv venv
- You should see a new folder called
venv
- You should see a new folder called
- Install the relevant packages
- Make sure your virtual environment is activated
- Run
source venv/bin/activate
- You should see
(venv)
appear on the Terminal prompt
- You should see
- Also check that
pip
is pointing to the instance from the venv, not from system:which pip
- Run
- Install the packages using
pip install -r requirements.txt
- Download the data files
- Follow the link in the
data
folder