Skip to main content

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.

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

Project details


Download files

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

Source Distribution

nanonispy-1.0.1.tar.gz (34.5 kB view hashes)

Uploaded source

Supported by

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