Installation¶

Follow these steps to install and run BatteryProc. The recommended setup uses a Conda environment with Python 3.11 (3.10+ supported). Python 3.12 works locally but is not yet tested in CI. A venv alternative is provided for users who do not use Conda.

0. Environment¶

1. Clone the Repository¶

git clone https://github.com/nickbashian/batteryproc.git
cd batteryproc

2. Recommended: Conda Environment¶

Create a Conda environment from the provided spec and activate it.

conda env create -f environment-simple.yml
conda activate batteryproc

In VS Code, select this interpreter: Command Palette → "Python: Select Interpreter" → the entry for miniconda3/envs/batteryproc/python (or the equivalent path on your OS).

To update the environment later:

conda env update -f environment-simple.yml --prune

3. Alternative: venv (No Conda)¶

# macOS/Linux
python3.11 -m venv .venv
source .venv/bin/activate

# Windows PowerShell
py -3.11 -m venv .venv
.venv\Scripts\Activate.ps1

4. Install the Package¶

Install BatteryProc in editable mode and (optionally) development tools:

pip install -e .
pip install -r requirements-dev.txt  # optional: tests/linting

5. Verify the Installation¶

batteryproc --help

If the help text is displayed, the installation is complete. Proceed to the Quick Start guide.