Igor2
=====
|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 <https://github.com/wking/igor>`_ project.
Installation
------------
You can install igor2 via pip::
pip install igor2
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 two command-line-interface (CLI) scripts,
``igorbinarywave`` and ``igorpackedexperiment`` which can be used to dump files
to stdout. You should install the ``[CLI]`` extra for them to fully work::
pip install igor2[CLI]
For details on their usage, use the ``--help`` option. For example::
igorbinarywave --help
Testing
-------
Run internal unit tests by cloning the repository and installing the
``[dev]`` extra and then running the tests::
git clone https://github.com/AFM-analysis/igor2.git
cd igor2
pip install -e .[dev]
pytest
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.
.. _GNU Lesser General Public License Version 3:
http://www.gnu.org/licenses/lgpl.txt
.. |PyPI Version| image:: https://img.shields.io/pypi/v/igor2.svg
:target: https://pypi.python.org/pypi/igor2
.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/AFM-analysis/igor2/check.yml?branch=master
:target: https://github.com/AFM-analysis/igor2/actions?query=workflow%3AChecks
.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/AFM-analysis/igor2/master.svg
:target: https://codecov.io/gh/AFM-analysis/igor2
Raw data
{
"_id": null,
"home_page": null,
"name": "igor2",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Paul Kienzle, W. Trevor King, Aurelien Jaquier, Zbigniew J\u0119drzejewski-Szmek, Paul M\u00fcller",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/15/55/942095911a2617a052158de4e5053d626f370a0ca2b13b747f0432af4501/igor2-0.5.9.tar.gz",
"platform": null,
"description": "Igor2\n=====\n\n|PyPI Version| |Build Status| |Coverage Status|\n\n\nPython parser for Igor Binary Waves (``.ibw``) and Packed Experiment\n(``.pxp``) files written by WaveMetrics' IGOR Pro software.\n\nIgor2 is the continuation of the inactive\n`igor <https://github.com/wking/igor>`_ project.\n\n\nInstallation\n------------\nYou can install igor2 via pip::\n\n pip install igor2\n\n\nUsage\n-----\nThis package is a direct replacement of `igor`. Your scripts should work\nwithout any issues if you replace::\n\n\n import igor\n\nwith::\n\n import igor2 as igor\n\n\nSee the docstrings and unit tests for examples using the Python API.\n\nCLI\n---\nThe package also installs two command-line-interface (CLI) scripts,\n``igorbinarywave`` and ``igorpackedexperiment`` which can be used to dump files\nto stdout. You should install the ``[CLI]`` extra for them to fully work::\n\n pip install igor2[CLI]\n\nFor details on their usage, use the ``--help`` option. For example::\n\n igorbinarywave --help\n\n\nTesting\n-------\n\nRun internal unit tests by cloning the repository and installing the\n``[dev]`` extra and then running the tests::\n\n git clone https://github.com/AFM-analysis/igor2.git\n cd igor2\n pip install -e .[dev]\n pytest\n\n\nLicence\n-------\n\nThis project is distributed under the `GNU Lesser General Public\nLicense Version 3`_ or greater, see the ``LICENSE`` file distributed\nwith the project for details.\n\n\n.. _GNU Lesser General Public License Version 3:\n http://www.gnu.org/licenses/lgpl.txt\n\n\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/igor2.svg\n :target: https://pypi.python.org/pypi/igor2\n.. |Build Status| image:: https://img.shields.io/github/actions/workflow/status/AFM-analysis/igor2/check.yml?branch=master\n :target: https://github.com/AFM-analysis/igor2/actions?query=workflow%3AChecks\n.. |Coverage Status| image:: https://img.shields.io/codecov/c/github/AFM-analysis/igor2/master.svg\n :target: https://codecov.io/gh/AFM-analysis/igor2\n",
"bugtrack_url": null,
"license": "GNU Lesser General Public License v3 or later (LGPLv3+)",
"summary": "interface for reading binary IGOR files",
"version": "0.5.9",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20c7be746a9dc05dfcad982f92fa59720578b208390225945f544e9a2deaf0b4",
"md5": "d59eaf8156247047dbb417ca060eac4f",
"sha256": "e24c5b64f955fe96e653a073fd63799450e5e07f3040a8e16ecf65add050d8f4"
},
"downloads": -1,
"filename": "igor2-0.5.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d59eaf8156247047dbb417ca060eac4f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.6",
"size": 32230,
"upload_time": "2024-11-06T10:25:00",
"upload_time_iso_8601": "2024-11-06T10:25:00.989901Z",
"url": "https://files.pythonhosted.org/packages/20/c7/be746a9dc05dfcad982f92fa59720578b208390225945f544e9a2deaf0b4/igor2-0.5.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1555942095911a2617a052158de4e5053d626f370a0ca2b13b747f0432af4501",
"md5": "d5bee1cc6d78b3af8679ae26edac6253",
"sha256": "14e5d4223dc8556cf13d03416fca35ded4b83c9c48a5d050ea9b4e5a1283033a"
},
"downloads": -1,
"filename": "igor2-0.5.9.tar.gz",
"has_sig": false,
"md5_digest": "d5bee1cc6d78b3af8679ae26edac6253",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.6",
"size": 59596,
"upload_time": "2024-11-06T10:25:02",
"upload_time_iso_8601": "2024-11-06T10:25:02.518428Z",
"url": "https://files.pythonhosted.org/packages/15/55/942095911a2617a052158de4e5053d626f370a0ca2b13b747f0432af4501/igor2-0.5.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-06 10:25:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "igor2"
}
JSON