https://github.com/underchemist/nanonispy
A small library written in python 3 to parse Nanonis binary and ascii files
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 6 committers (16.7%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.7%) to scientific vocabulary
Keywords
nanonis
parsing-library
science
Keywords from Contributors
stm
Last synced: 6 months ago
·
JSON representation
Repository
A small library written in python 3 to parse Nanonis binary and ascii files
Basic Info
Statistics
- Stars: 27
- Watchers: 8
- Forks: 25
- Open Issues: 3
- Releases: 1
Topics
nanonis
parsing-library
science
Created about 10 years ago
· Last pushed almost 3 years ago
Metadata Files
Readme
Changelog
License
README.rst
|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.
.. code:: python
import nanonispy as nap
Then given a file,
.. code:: python
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
.
.. |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
Owner
- Name: Yann-Sebastien Tremblay-Johnston
- Login: underchemist
- Kind: user
- Location: Vancouver, BC
- Company: @sparkgeo
- Website: yanns.tremblay@gmail.com
- Repositories: 53
- Profile: https://github.com/underchemist
Nothing works.
GitHub Events
Total
- Issues event: 1
- Watch event: 3
- Issue comment event: 1
- Pull request event: 2
- Fork event: 2
Last Year
- Issues event: 1
- Watch event: 3
- Issue comment event: 1
- Pull request event: 2
- Fork event: 2
Committers
Last synced: over 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Yann-Sebastien | y****y@g****m | 101 |
| Patrik Marschalik | m****k@f****g | 4 |
| Yann-Sebastien Tremblay-Johnston | u****t | 4 |
| yuksk | k****a@r****p | 3 |
| Jack Hellerstedt | h****k@g****m | 1 |
| Unknown | c****5@u****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 9
- Total pull requests: 15
- Average time to close issues: 3 months
- Average time to close pull requests: 4 months
- Total issue authors: 6
- Total pull request authors: 8
- Average comments per issue: 1.78
- Average comments per pull request: 1.67
- Merged pull requests: 9
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 1
- Average time to close issues: 15 days
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 3.0
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jhellerstedt (3)
- donpatrice (2)
- narpfel (1)
- fabioacl (1)
- underchemist (1)
- starfetcher (1)
Pull Request Authors
- yuksk (4)
- 6NiceRice9 (3)
- 404-James-404 (3)
- underchemist (3)
- jhellerstedt (2)
- ramav87 (1)
- donpatrice (1)
- CompPhysChris (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 389 last-month
- Total dependent packages: 1
- Total dependent repositories: 5
- Total versions: 10
- Total maintainers: 1
pypi.org: nanonispy
Library to parse Nanonis files.
- Homepage: https://github.com/underchemist/nanonispy
- Documentation: https://nanonispy.readthedocs.io/
- License: MIT
-
Latest release: 1.1.0
published about 5 years ago
Rankings
Dependent packages count: 4.7%
Dependent repos count: 6.7%
Forks count: 8.4%
Average: 11.4%
Stargazers count: 12.9%
Downloads: 24.6%
Maintainers (1)
Last synced:
about 1 year ago
Dependencies
requirements.txt
pypi
- nose *
- numpy *
setup.py
pypi
- numpy *
pyproject.toml
pypi