# nanonis-reader package [](https://pypi.org/project/nanonis-reader/)
**nanonis-reader** is a Python library designed to help you analyze and visualize data with ease.
---
## Installation
### From PyPI
You can install the latest stable release from PyPI:
```
pip install nanonis-reader
```
## Usage
### Example
When you input Nanonis file numbers, corresponding files will be automatically generated as a pptx file.
```python
import nanonis-reader as nr
path = 'your_folder_path'
ppt_maker = nr.util.DataToPPT(base_path=path, keyword='your_file_keyword', output_filename='your_file_name.pptx')
ppt_maker.generate_ppt()
```
Then, you will get below:
```terminal
Maximum file number in directory: XXXX
Enter start number (or 'q' to quit):
```
Enter the starting file number here.
```terminal
Enter end number (or 'q' to quit):
```
Enter the ending file number here.
```terminal
Generate PPT for files 1 to 1? (y/n):
```
Enter 'y' to generate the PowerPoint file.
Raw data
{
"_id": null,
"home_page": "https://github.com/D-gitt/nanonis_reader",
"name": "nanonis-reader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "nanonis, reader, nanonispy, STM data, scientific data analysis",
"author": "Dowook Kim",
"author_email": "dw.kim@postech.ac.kr",
"download_url": "https://files.pythonhosted.org/packages/6e/ba/4d820462fad768b0028793a0c433939ee2388d46b09e2676056fdf4cee55/nanonis_reader-0.1.6.tar.gz",
"platform": null,
"description": "# nanonis-reader package [](https://pypi.org/project/nanonis-reader/)\n\n**nanonis-reader** is a Python library designed to help you analyze and visualize data with ease. \n\n---\n\n## Installation\n\n### From PyPI\n\nYou can install the latest stable release from PyPI:\n\n```\npip install nanonis-reader\n```\n\n## Usage\n\n### Example\n\nWhen you input Nanonis file numbers, corresponding files will be automatically generated as a pptx file.\n\n```python\nimport nanonis-reader as nr\npath = 'your_folder_path'\nppt_maker = nr.util.DataToPPT(base_path=path, keyword='your_file_keyword', output_filename='your_file_name.pptx')\nppt_maker.generate_ppt()\n```\n\nThen, you will get below:\n\n```terminal\nMaximum file number in directory: XXXX\nEnter start number (or 'q' to quit): \n```\n\nEnter the starting file number here.\n\n```terminal\nEnter end number (or 'q' to quit): \n```\n\nEnter the ending file number here.\n\n```terminal\nGenerate PPT for files 1 to 1? (y/n): \n```\n\nEnter 'y' to generate the PowerPoint file.\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python package for reading STM experimental data files obtained from Nanonis, based on nanonispy",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/D-gitt/nanonis_reader"
},
"split_keywords": [
"nanonis",
" reader",
" nanonispy",
" stm data",
" scientific data analysis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2058890203b90d42e57e10eb3452ad0b6deadb7fc9755636213c91bbff2436f3",
"md5": "30107b9f20c48b247b396a2e7f8eff76",
"sha256": "76c539941748819e77f01dc0c78b76395814465b7afe30eaf273d12dbb1abc60"
},
"downloads": -1,
"filename": "nanonis_reader-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "30107b9f20c48b247b396a2e7f8eff76",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 25862,
"upload_time": "2025-01-23T10:34:34",
"upload_time_iso_8601": "2025-01-23T10:34:34.821633Z",
"url": "https://files.pythonhosted.org/packages/20/58/890203b90d42e57e10eb3452ad0b6deadb7fc9755636213c91bbff2436f3/nanonis_reader-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6eba4d820462fad768b0028793a0c433939ee2388d46b09e2676056fdf4cee55",
"md5": "3dd10008f2cf7cfdc2c4b586f0d0ad2e",
"sha256": "1c58d95891b8f57fd117a432d0c0939ee406ed6b2bd809ad7b431d866051b04d"
},
"downloads": -1,
"filename": "nanonis_reader-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "3dd10008f2cf7cfdc2c4b586f0d0ad2e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 22869,
"upload_time": "2025-01-23T10:34:36",
"upload_time_iso_8601": "2025-01-23T10:34:36.057525Z",
"url": "https://files.pythonhosted.org/packages/6e/ba/4d820462fad768b0028793a0c433939ee2388d46b09e2676056fdf4cee55/nanonis_reader-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 10:34:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "D-gitt",
"github_project": "nanonis_reader",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nanonis-reader"
}
JSON
