Skip to main content

interface for reading binary IGOR files

Project description

PyPI Version Build Status Coverage Status

Python parser for Igor Binary Waves (.ibw) and Packed Experiment (.pxp) files written by WaveMetrics’ IGOR Pro software.

Igor2 is the continuation of the inactive igor project, forked from W. Trevor King and originally written by Paul Kienzle (see git history).

Installation

You can install igor2 via pip:

pip install igor2

The commands igorbinarywave and igorpackedexperiment are currently not properly implemented (see https://github.com/AFM-analysis/igor2/issues/6), but it should be straight-forward to fix this.

To install igor2 with the command-line interface (CLI), run:

pip install igor2[CLI]

Usage

This package is a direct replacement of igor. Your scripts should work without any issues if you replace:

import igor

with:

import igor2 as igor

See the docstrings and unit tests for examples using the Python API.

CLI

The package also installs to scripts, igorbinarywave and igorpackedexperiment which can be used to dump files to stdout. For details on their usage, use the --help option. For example:

igorbinarywave --help

Testing

Run internal unit tests with pytest:

pip install -r tests/requirements.txt
pytest tests

The data in the test/data directory is in the Git repository, but it is not bundled with the source code. If you want the test data, you’ll have to clone the Git repository or download a snapshot.

Licence

This project is distributed under the GNU Lesser General Public License Version 3 or greater, see the LICENSE file distributed with the project for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

igor2-0.5.2-py3-none-any.whl (31.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page