Getting Started

Installation

The BaSD tool requires Python 3.10+ to run. The BaSD tool has few dependencies, nevertheless it is strongly suggested that BaSD is installed into a virtual environment.

From pip

The BaSD tool can be installed by running

$ # create a new virtual environment and activate it
$ python -m pip install basd

From sources

To install the latest development version run

$ # create a new virtual environment and activate it
$ python -m pip install git+https://github.com/foxbms/battery-system-designer

Verification

To verify that everything works as expect run, call help on the BaSD’s main module:

$ # activate the environment basd has been installed into
$ basd --help

This should render the following help message on the console

Usage: python -m basd [OPTIONS] COMMAND [ARGS]...

  BaSD provides functionalities to design battery system in a pipeline
  architecture

Options:
  --version          Show the version and exit.
  -s, --show-config  Shows the program information
  -h, --help         Show this message and exit.

Commands:
  cad     system design task
  db      BaSD database command
  design  system design task
  sim     system simulation task

Next steps

The Usage sections explains

• how to first add battery cells to the user’s database

• how to provide requirements to the design tool

• how to visualize the resulting battery systems

• how to simulate a load profile against the resulting battery systems