Metadata-Version: 2.3
Name: anasyspythontools
Version: 0.5.2
Summary: A suite of Python tools for use with Analysis Studio AFM-IR files.
Project-URL: Homepage, https://github.com/GeorgRamer/anasys-python-tools
Author-email: Georg Ramer <georg.ramer@tuwien.ac.at>, Wouter Duverger <wouter.duverger@kuleuven.be>, Cody Schindler <cschindler@anasysinstruments.com>
License: MIT
Keywords: .axd,.axz,AFM,AFM-IR,Anasys,Instruments,atomic,axd,axz,force,hyperspectral,infrared,microscope,microscopy,s-snom,spectra,spectroscopy,spectrum,ssnom
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.8
Requires-Dist: ipython>=7.0
Requires-Dist: matplotlib-scalebar>=0.8.1
Requires-Dist: matplotlib>=3.5.3
Requires-Dist: numpy>=1.22
Requires-Dist: scipy>=1.9.1
Requires-Dist: xarray>=2022.6.0
Description-Content-Type: text/x-rst

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.