Skip to main content

build coverage Documentation Status pypi zenodo

Preparing Novonix Data

preparenovonix is a Python package that handles common issues encountered in data files generated with a range of software versions from the Novonix battery-testers. This package can also add extra information that makes easier coulombic counting and relating a measurement to the experimental protocol. The package provides a master function, prepare_novonix, that can run at once the cleaning and adding derived information, with flexibility to choose only some features. There is a separate function to simply read a column by its given name.

Example

The example.py runs over the given example data, producing a new file and a plot that compares the original and the prepared data. To run this example, simply type: python example.py.

Requirements and Installation

This code has been developed in Python 3.7.1 and it is compatible with Python above 3.5 versions. The code has been tested to run in Windows, OSX and Linux operating systems.

This code uses numpy as specified in docs/requirements.txt. The ploting routine from the example.py also requires the use of matplotlib.

The code can be run directly from a cloned GitHub repository or it can also be installed as a python package through pip:

pip install preparenovonix

The functions in the package can be used after importing novonix_add, for example as follows:

import preparenovonix.novonix_add as prep

The code has been tested within Matlab R2018a.

Running preparenovonix code from MatLab

To run the code from Matlab, Python will need to be installed including the packages: numpy, pathlib and preparenovonix (see details above). Ensure that Matlab can see your installation of Python by running pyversion. If this is not the case then: (i) find where your Python executable is (within a python terminal you can do this by typing: import os, sys ; os.path.dirname(sys.executable)), (ii) type within your MatLab interpreter pyversion [path to python executable] and (iii) check that now the path to Python is recognised with pyversion. Make sure that

In your code you can add the following lines that will call the master function from the package, catching exceptions:

try
     py.preparenovonix.novonix_prep.prepare_novonix(file_to_open,...
             pyargs('addstate','True',...
             'lprotocol','True',...
             'overwrite','True',...
             'verbose','False'));
catch e
     e.message
     if(isa(e,'matlab.exception.PyException'))
             e.ExceptionObject
     end
end

Compatibility

This code has been tested with data generated by different versions of the Novonix software. If you encounter issues running the code for any version of Novonix software report an issue. Note that an example file will be needed in order to improve the code. List of the Novonix software. If you encounter issues running the code for any version of Novonix software report an issue. Note that an example file will be needed in order to improve the code. List of the Novonix software versions the code has been tested against:

  • 3.0.2.3

  • 3.0.2.1

  • TO

  • 2.0.0.7

  • 1.9.4.0

Metadata

Release files for preparenovonix 1.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for preparenovonix 1.0.3
File Size Uploaded Provenance Actions
preparenovonix-1.0.3.tar.gz 17.7 kB Without provenance Details for preparenovonix-1.0.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for preparenovonix 1.0.3
File Interpreter ABI Platform Actions
preparenovonix-1.0.3-py3-none-any.whl Python 3 none any Details for preparenovonix-1.0.3-py3-none-any.whl

Total release size: 48.4 kB

Release files / preparenovonix-1.0.3.tar.gz

Download URL preparenovonix-1.0.3.tar.gz
Size 17.7 kB
Tags Source
SHA-256 checksum
How to use checksums
684a1434457dd2695f5a4afee7fbf3892188c290260c831ab9abdf67cb994edc
BLAKE2b-256 checksum
How to use checksums
310c1aa7d1bca131a189d3e2f33ac4bc59fbb39001317866d4a2683142567541
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

Release files / preparenovonix-1.0.3-py3-none-any.whl

Download URL preparenovonix-1.0.3-py3-none-any.whl
Size 30.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8877c0993b7737abc24fe2e5ff5c60fba087f84de6345481b08fbfe5dad5092c
BLAKE2b-256 checksum
How to use checksums
345971578c0388b237191e9665656cb506bba5091a695acccec7276124156640
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

Security for preparenovonix 1.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page