Skip to content

Commit

Permalink
update .rst readme for pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
underchemist committed Dec 26, 2015
1 parent 0fbf713 commit 6de504d
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
|Build Status| |Coverage Status| # nanonispy
|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
Currently written and tested with
- python 3.5
- python 3.4
- python 3.3

Depends on - numpy
Depends on
- numpy

Will continue making tests that are actually useful and maybe will make
this a conda/pip build.

Install
-------
Expand Down Expand Up @@ -42,8 +47,7 @@ Simply clone this repo and run
Basic usage
-----------

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

.. code:: python
Expand Down Expand Up @@ -85,17 +89,18 @@ this) with

.

*I don't know how to turn tests without nose...*

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

.. |Build Status| image:: https://travis-ci.org/underchemist/nanonispy.svg?branch=master
:target: https://travis-ci.org/underchemist/nanonispy
.. |Coverage Status| image:: https://coveralls.io/repos/underchemist/nanonispy/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/underchemist/nanonispy?branch=master
.. |Install with conda| image:: https://anaconda.org/underchemist/nanonispy/badges/installer/conda.svg
:target: https://anaconda.org/underchemist/nanonispy/badges/installer/conda.svg

0 comments on commit 6de504d

Please sign in to comment.