A standalone Python API and command line interface (CLI) to control Neware battery cyclers.

It is designed for BTS 8.0 and WHW-200L-160CH-B systems, and should work on other cyclers using BTS 8.0.

Features

• CLI and Python API
• Connect to Neware cyclers
• Retrieve status, data, logs
• Start and stop experiments

Installation

Install on a Windows PC with BTS server and client 8.0, connected to one or more Neware cyclers with the API activated.

In a Python >3.12 environment, run:

pip install aurora-neware

Important

Your BTS software must have the API activated, accessed with Help -> Mode settings.

You may need to contact Neware for an activation key.

CLI usage

See commands and arguments with

neware --help
neware <COMMAND> --help

E.g. to check the status of all channels use

neware status

To start a job use

neware start "pipeline_id" "my_sample" "my_protocol.xml"

A pipeline is defined by {Device ID}-{Sub-device ID}-{Channel ID}, e.g. "100-2-3" for machine 100, sub-device 2, channel 3.

API usage

Commands are also available through Python, e.g.

from aurora_neware import NewareAPI

with NewareAPI() as nw:  # connect to the instrument
    nw.start(
        "pipeline_id",
        "my_sample",
        "my_protocol.xml",
    )

Contributors

• Graham Kimbell
• Aliaksandr Yakutovich

Acknowledgements

This software was developed at the Laboratory of Materials for Energy Conversion at Empa, the Swiss Federal Laboratories for Materials Science and Technology, and supported by funding from the IntelLiGent project and Battery 2030+ initiative from the European Union’s research and innovation program under grant agreement No. 101069765 and No. 101104022 and from the Swiss State Secretariat for Education, Research, and Innovation (SERI) under contract No. 22.001422 and 300313.