Installation

User

If you just intent to use the BaSD tool, see the Getting Started section to install BaSD as a user.

For Development

1. Install VS Code

2. Set up the development environment:

   $ # user: activate any conda base environment
   $ conda update -y -n base -c defaults conda
   $ python -m pip install pip --upgrade
   $ conda create -y -n basd-devel-env-11 python=3.10 pip
   $ conda activate basd-devel-env-11
   $ python -m pip install flit --upgrade
   $ git clone https://github.com/foxBMS/BaSD
   $ cd battery-system-designer
   $ python -m flit install --deps all --only-deps
   

3. Activate the development environment, make changes and run the tools

   $ # user: activate any conda base environment
   $ conda activate basd-devel-env-11
   $ cd path/to/repo
   $ code .
   $ cd src # testing needs to be run in source directory
   $ python -m basd design -r ../tests/requirements/Example-system.json --database ../tests/cells
   

Packaging

$ # user: activate any conda base environment
$ conda activate basd-devel-env-11
$ cd path/to/repo
$ flit build

Documentation Build

$ # user: activate any conda base environment
$ conda activate basd-devel-env-11
$ cd path/to/repo
$ cd docs
$ make html