Setting up the Python Environment
- Updated2025-10-15
- 1 minute(s) read
Install the NI Battery Cell Quality Toolkit Python package to script tests.
Introduced in Battery Cell Quality Toolkit 2025 Q4
Note For
more information on the Python API for this product, refer to the nibcq API
Reference.
-
Use Package Manager on a Windows machine to install the
following runtimes.
Note Installing the Battery Cell Quality Toolkit automatically adds these runtimes to the machine. You can also install these runtimes one at a time.
- NI-DAQmx
- NI-DCPower
- NI-DMM
- NI-SWITCH
- Download and install Python 3.12 or later.
- In the nibcq-python GitHub repository, navigate to the \examples folder and download the example files.
-
Create a virtual environment for the test.
python -m venv bcqtest bcqtest\Scripts\activate
- Optional:
To install from the testing instance of the Python Package Index
(test.pypi), add the following dependencies.
pip install nidaqmx pip install nidcpower pip install nidmm pip install niswitch
-
Install the nibcq package.
- If you are installing the official release, use the following
command:
pip install nibcq
- If you are installing from the Python Package Index (PyPI) test
environment, use the following
command:
pip install -i https://test.pypi.org/simple/ nibcq
- If you are installing the official release, use the following
command:
-
Run the Python examples.
- To run the EIS examples, add the plotting
packages.
pip install matplotlib
- To run a Python file from the example files directory, use the following
command.
python simulated_dmm_device.py
- Modify device names in the example
scripts.
Device.create(DeviceFamily.SMU, resource_name="[NAME]")
- To run the EIS examples, add the plotting
packages.