Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

Library to parse Nanonis files.

Project description

Build Status Coverage Status Install with conda

nanonispy

A small library written in python 3 to parse Nanonis binary and ascii files.

Nanonispy was made in needing to do a lot of analysis for scanning tunneling microscopy (STM) data, and thought this would be good practice in creating a proper python library. That being said it is in no way foolproof and if anybody else actually uses this please let me know if you run into issues.

Nanonispy can read Nanonis grid, scan, and point spectroscopy files. This means it will read the file header and parse that into a somewhat useful dictionary for later use, as well as read in the binary/ascii data in a relatively general way to accomadate data with multiple channels stored, or custom spectroscopy experiments.

Requirements

Currently written and tested with

  • python 3.9
  • python 3.8
  • python 3.7
  • python 3.6

Depends on

  • numpy

Install

For the most up-to-date version, install from github as pip and conda packages are not updated as frequently.

pip

pip install nanonispy

conda

conda install --channel https://conda.anaconda.org/underchemist nanonispy

github

Simply clone this repo and run

python setup.py install

Basic usage

Once installed, you should be able to import it to any python script or ipython session.

import nanonispy as nap

Then given a file,

grid = nap.read.Grid('/path/to/datafile.3ds')

You can look at the attributes and methods to determine the information available.

Running tests

Similar to the install, except run

python setup.py test

. If you have the nose module installed, it’s as simple as

nosetests

.

You can also see coverage of the tests as well as ignore the test discovery of numpy core packages (don’t quite understand why it does this) with

nosetests --with-coverage --cover-branches --cover-package=nanonispy

.

Project details


Download files

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

Files for nanonispy, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size nanonispy-1.1.0-py3-none-any.whl (10.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size nanonispy-1.1.0.tar.gz (12.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page