Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Library to parse Nanonis files.

Project Description

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.5
  • python 3.4
  • python 3.3

Depends on

  • numpy

Install

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

.

To do

  • homogenize grid and scan header keys, right now header formats are pretty different and I’m to lazy to do it myself.
  • more relevant tests
  • saving methods
  • handle incomplete scans/grids
Release History

Release History

This version
History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
nanonispy-1.0.4.tar.gz (35.6 kB) Copy SHA256 Checksum SHA256 Source Sep 13, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting