anasyspythontools


Nameanasyspythontools JSON
Version 0.5.2 PyPI version JSON
download
home_pageNone
SummaryA suite of Python tools for use with Analysis Studio AFM-IR files.
upload_time2024-12-13 14:24:36
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT
keywords .axd .axz afm afm-ir anasys instruments atomic axd axz force hyperspectral infrared microscope microscopy s-snom spectra spectroscopy spectrum ssnom
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            NOTE
-----

Please note that this package is currently beta. Things may break unexpectedly. Most functions writing to Analysis Studio format have been disabled so I don't see how this package could break your existing data anymore. 

Anasys Python Tools
===================

Anasys Python Tools is a python package for working with files generated by Anasys Instruments' (now Bruker) Analysis Studio software. Anasys Python Tools was originally developed by Cody Schindler from Anasys.


Basic Usage
-----------
.. code-block:: python

  import anasyspythontools as anasys
  # Read your Analysis Studio file
  f = anasys.read("afmdata.axz")
  # Grab all the height map data from the file
  heightmaps = f.HeightMaps
  # Show off your beautiful images
  heightmaps['Height 1'].show()
  # Unsure what the data looks like? Try:
  dir(f) # Displays user-accessible data
  dir(f.HeightMaps)
  
  
More useage information can be found in the `examples` folder.


Features
--------

- Read files with .axz, .axd, file extensions
- Extract AFM spectral and height map images as numpy arrays
- Export spectra and images to xarray type
- Quickly display and save your data
- Use your data with popular Python data libraries and applications (Pandas, Orange3, Jupyter, etc.)
- Work with your data when you're away from your instruments
- Evaluate your data in a trasparent and flexible way


Installation
------------

**From pip**

.. code-block:: bash
  
  pip install anasyspythontools


**From github**


Install the latest version:

.. code-block:: bash

  pip install git+https://github.com/GeorgRamer/anasys-python-tools.git 
  
or a specific branch:

.. code-block:: bash

  pip install git+https://github.com/GeorgRamer/anasys-python-tools.git@<branchname>

Contribute
----------

- Feel free to fork and hack away!
- If you have a feature you'd like to see, please open an Issue.

Support
-------

This section previously said: 

  If you are having issues, please let us know.
  Email Cody directly at cschindler@anasysinstruments.com
  
Since Cody appears to have stopped working on this, please raise issues in this fork or email Georg at georg.ramer@tuwien.ac.at

License
-------

The project is licensed under the MIT license.

Each .py file in this document has a header stating:

.. code-block:: python

  #  Copyright 2017 Cody Schindler <cschindler@anasysinstruments.com>
  #
  #  This program is the property of Anasys Instruments, and may not be
  #  redistributed or modified without explict permission of the author.

To my understanding the MIT license constitutes an "explicit permission" to redistribute and modify. To be on the safe side, I (GeorgRamer) have repeatedly, over a span of several years tried to get confirmation on that from Bruker. I never got a definite answer.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "anasyspythontools",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": ".axd, .axz, AFM, AFM-IR, Anasys, Instruments, atomic, axd, axz, force, hyperspectral, infrared, microscope, microscopy, s-snom, spectra, spectroscopy, spectrum, ssnom",
    "author": null,
    "author_email": "Georg Ramer <georg.ramer@tuwien.ac.at>, Wouter Duverger <wouter.duverger@kuleuven.be>, Cody Schindler <cschindler@anasysinstruments.com>",
    "download_url": "https://files.pythonhosted.org/packages/48/b3/cf124f084c11fc238714f7d5aaabf2566204f30cfad17891fb3620260d2a/anasyspythontools-0.5.2.tar.gz",
    "platform": null,
    "description": "NOTE\n-----\n\nPlease note that this package is currently beta. Things may break unexpectedly. Most functions writing to Analysis Studio format have been disabled so I don't see how this package could break your existing data anymore. \n\nAnasys Python Tools\n===================\n\nAnasys Python Tools is a python package for working with files generated by Anasys Instruments' (now Bruker) Analysis Studio software. Anasys Python Tools was originally developed by Cody Schindler from Anasys.\n\n\nBasic Usage\n-----------\n.. code-block:: python\n\n  import anasyspythontools as anasys\n  # Read your Analysis Studio file\n  f = anasys.read(\"afmdata.axz\")\n  # Grab all the height map data from the file\n  heightmaps = f.HeightMaps\n  # Show off your beautiful images\n  heightmaps['Height 1'].show()\n  # Unsure what the data looks like? Try:\n  dir(f) # Displays user-accessible data\n  dir(f.HeightMaps)\n  \n  \nMore useage information can be found in the `examples` folder.\n\n\nFeatures\n--------\n\n- Read files with .axz, .axd, file extensions\n- Extract AFM spectral and height map images as numpy arrays\n- Export spectra and images to xarray type\n- Quickly display and save your data\n- Use your data with popular Python data libraries and applications (Pandas, Orange3, Jupyter, etc.)\n- Work with your data when you're away from your instruments\n- Evaluate your data in a trasparent and flexible way\n\n\nInstallation\n------------\n\n**From pip**\n\n.. code-block:: bash\n  \n  pip install anasyspythontools\n\n\n**From github**\n\n\nInstall the latest version:\n\n.. code-block:: bash\n\n  pip install git+https://github.com/GeorgRamer/anasys-python-tools.git \n  \nor a specific branch:\n\n.. code-block:: bash\n\n  pip install git+https://github.com/GeorgRamer/anasys-python-tools.git@<branchname>\n\nContribute\n----------\n\n- Feel free to fork and hack away!\n- If you have a feature you'd like to see, please open an Issue.\n\nSupport\n-------\n\nThis section previously said: \n\n  If you are having issues, please let us know.\n  Email Cody directly at cschindler@anasysinstruments.com\n  \nSince Cody appears to have stopped working on this, please raise issues in this fork or email Georg at georg.ramer@tuwien.ac.at\n\nLicense\n-------\n\nThe project is licensed under the MIT license.\n\nEach .py file in this document has a header stating:\n\n.. code-block:: python\n\n  #  Copyright 2017 Cody Schindler <cschindler@anasysinstruments.com>\n  #\n  #  This program is the property of Anasys Instruments, and may not be\n  #  redistributed or modified without explict permission of the author.\n\nTo my understanding the MIT license constitutes an \"explicit permission\" to redistribute and modify. To be on the safe side, I (GeorgRamer) have repeatedly, over a span of several years tried to get confirmation on that from Bruker. I never got a definite answer.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A suite of Python tools for use with Analysis Studio AFM-IR files.",
    "version": "0.5.2",
    "project_urls": {
        "Homepage": "https://github.com/GeorgRamer/anasys-python-tools"
    },
    "split_keywords": [
        ".axd",
        " .axz",
        " afm",
        " afm-ir",
        " anasys",
        " instruments",
        " atomic",
        " axd",
        " axz",
        " force",
        " hyperspectral",
        " infrared",
        " microscope",
        " microscopy",
        " s-snom",
        " spectra",
        " spectroscopy",
        " spectrum",
        " ssnom"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e83e26e6d065335c6a1f1379168e9ed803dfa0cd7393c4ba35995cf471021432",
                "md5": "ed6e28f889b4291c606e37c502b4d0ec",
                "sha256": "0553b7971383f243edd56bf2bb37667aec63a9d4fc48d4d7b2844b4b32eb68be"
            },
            "downloads": -1,
            "filename": "anasyspythontools-0.5.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ed6e28f889b4291c606e37c502b4d0ec",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 32771,
            "upload_time": "2024-12-13T14:24:31",
            "upload_time_iso_8601": "2024-12-13T14:24:31.772720Z",
            "url": "https://files.pythonhosted.org/packages/e8/3e/26e6d065335c6a1f1379168e9ed803dfa0cd7393c4ba35995cf471021432/anasyspythontools-0.5.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "48b3cf124f084c11fc238714f7d5aaabf2566204f30cfad17891fb3620260d2a",
                "md5": "a7f76c6078de43c1fe82fd7aed4a6965",
                "sha256": "fb782c4b7b8f32bb88ef7e8ab80803cbd58f92e44eb1cd74c0dcba6076e4fbc9"
            },
            "downloads": -1,
            "filename": "anasyspythontools-0.5.2.tar.gz",
            "has_sig": false,
            "md5_digest": "a7f76c6078de43c1fe82fd7aed4a6965",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 25422,
            "upload_time": "2024-12-13T14:24:36",
            "upload_time_iso_8601": "2024-12-13T14:24:36.562619Z",
            "url": "https://files.pythonhosted.org/packages/48/b3/cf124f084c11fc238714f7d5aaabf2566204f30cfad17891fb3620260d2a/anasyspythontools-0.5.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-13 14:24:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "GeorgRamer",
    "github_project": "anasys-python-tools",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "anasyspythontools"
}
        
Elapsed time: 4.63438s