| Name | rhkpy JSON |
| Version |
1.3.8
JSON |
| download |
| home_page | https://github.com/zrbyte/rhkpy |
| Summary | A python package for processing Scanning Tunneling Microscopy (STM) data from RHK, based on the spym project. |
| upload_time | 2024-06-21 13:49:08 |
| maintainer | None |
| docs_url | None |
| author | Peter Nemes-Incze |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# RHK STM data analysis tool
Based on the [spym project](https://github.com/rescipy-project/spym) (version 0.9.1).
Documentation can be found here: https://zrbyte.github.io/rhkpy/
[](https://mybinder.org/v2/gh/zrbyte/rhkpy/HEAD)
If you use this package in your publication, consider citing it:
Peter Nemes-I., & Mirco Panighel. (2023). zrbyte/rhkpy: v1.3.3 (v1.3.3). Zenodo. https://zenodo.org/doi/10.5281/zenodo.10143224
[](https://doi.org/10.5281/zenodo.10143224)
## Main features
- Able to handle spectroscopy measurements (both dI/dV and I(z)):
- dI/dV maps
- spectra along a line
- individual spectra
- Resample dI/dV maps along a line (see [`mapsection`](https://zrbyte.github.io/rhkpy/rhkpy.html#rhkpy.rhkpy_process.mapsection))
- Quick, interactive visualization of spectroscopy data (see [`qplot`](https://zrbyte.github.io/rhkpy/rhkpy.html#rhkpy.rhkpy_loader.rhkdata.qplot))
- Recreating the "navigation" window in Rev9, by plotting the relative positions of measurements (see the [`navigation`](https://zrbyte.github.io/rhkpy/rhkpy.html#rhkpy.rhkpy_process.navigation) function).
- Generating thumbnails of your measurements (see [`genthumbs`](https://zrbyte.github.io/rhkpy/rhkpy.html#rhkpy.rhkpy_process.genthumbs))
- Peak fitting (see [`peakfit`](https://zrbyte.github.io/rhkpy/rhkpy.html#rhkpy.rhkpy_process.peakfit))
## Installation
`pip install rhkpy`
## Simple example
```python
import rhkpy
# Load an sm4 file
data = rhkpy.rhkdata('filename.sm4')
# "quick plot" of the data
data.qplot()
# make thumbnails of the sm4 files in the current working directory
rhkpy.genthumbs()
```
Also take a look at the `demo.ipynb` and `tutorial.ipynb` Jupyter notebooks in this repository.
To make the most of rhkpy, also consult the xarray documentation and check out plotting examples, with HoloViews. The HoloViews website has examples on how to customize plots, as well as tutorial notebooks.
Raw data
{
"_id": null,
"home_page": "https://github.com/zrbyte/rhkpy",
"name": "rhkpy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Peter Nemes-Incze",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d1/03/3f60a22217f6450a1258471d6313f558cfdb5c804e279b24af04c70f74d0/rhkpy-1.3.8.tar.gz",
"platform": null,
"description": "# RHK STM data analysis tool\n\nBased on the [spym project](https://github.com/rescipy-project/spym) (version 0.9.1).\n\nDocumentation can be found here: https://zrbyte.github.io/rhkpy/\n\n[](https://mybinder.org/v2/gh/zrbyte/rhkpy/HEAD)\n\nIf you use this package in your publication, consider citing it:\nPeter Nemes-I., & Mirco Panighel. (2023). zrbyte/rhkpy: v1.3.3 (v1.3.3). Zenodo. https://zenodo.org/doi/10.5281/zenodo.10143224\n[](https://doi.org/10.5281/zenodo.10143224)\n\n## Main features\n- Able to handle spectroscopy measurements (both dI/dV and I(z)):\n - dI/dV maps\n - spectra along a line\n - individual spectra\n- Resample dI/dV maps along a line (see [`mapsection`](https://zrbyte.github.io/rhkpy/rhkpy.html#rhkpy.rhkpy_process.mapsection))\n- Quick, interactive visualization of spectroscopy data (see [`qplot`](https://zrbyte.github.io/rhkpy/rhkpy.html#rhkpy.rhkpy_loader.rhkdata.qplot))\n- Recreating the \"navigation\" window in Rev9, by plotting the relative positions of measurements (see the [`navigation`](https://zrbyte.github.io/rhkpy/rhkpy.html#rhkpy.rhkpy_process.navigation) function).\n- Generating thumbnails of your measurements (see [`genthumbs`](https://zrbyte.github.io/rhkpy/rhkpy.html#rhkpy.rhkpy_process.genthumbs))\n- Peak fitting (see [`peakfit`](https://zrbyte.github.io/rhkpy/rhkpy.html#rhkpy.rhkpy_process.peakfit))\n\n## Installation\n`pip install rhkpy`\n\n## Simple example\n```python\nimport rhkpy\n\n# Load an sm4 file\ndata = rhkpy.rhkdata('filename.sm4')\n\n# \"quick plot\" of the data\ndata.qplot()\n\n# make thumbnails of the sm4 files in the current working directory\nrhkpy.genthumbs()\n```\n\nAlso take a look at the `demo.ipynb` and `tutorial.ipynb` Jupyter notebooks in this repository.\n\nTo make the most of rhkpy, also consult the xarray documentation and check out plotting examples, with HoloViews. The HoloViews website has examples on how to customize plots, as well as tutorial notebooks.\n",
"bugtrack_url": null,
"license": null,
"summary": "A python package for processing Scanning Tunneling Microscopy (STM) data from RHK, based on the spym project.",
"version": "1.3.8",
"project_urls": {
"Homepage": "https://github.com/zrbyte/rhkpy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "297784c0384a53cd6691b614fea756f8ba7fdf05024711565fc17901b25d8cae",
"md5": "002aacbadc8f3fae132698c421e9f139",
"sha256": "35f9aff2f5e0dca40915b7a07f49130ed96603d2f05939c890c9171d73e741d4"
},
"downloads": -1,
"filename": "rhkpy-1.3.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "002aacbadc8f3fae132698c421e9f139",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 45602,
"upload_time": "2024-06-21T13:49:07",
"upload_time_iso_8601": "2024-06-21T13:49:07.174238Z",
"url": "https://files.pythonhosted.org/packages/29/77/84c0384a53cd6691b614fea756f8ba7fdf05024711565fc17901b25d8cae/rhkpy-1.3.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d1033f60a22217f6450a1258471d6313f558cfdb5c804e279b24af04c70f74d0",
"md5": "2a797c1af56e050b71ecb680ad0ebb30",
"sha256": "c3212b0bd39d45cac87cf147695c9c121b99e7b6496b2ab87a858f4bc80f3c03"
},
"downloads": -1,
"filename": "rhkpy-1.3.8.tar.gz",
"has_sig": false,
"md5_digest": "2a797c1af56e050b71ecb680ad0ebb30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 42038,
"upload_time": "2024-06-21T13:49:08",
"upload_time_iso_8601": "2024-06-21T13:49:08.931137Z",
"url": "https://files.pythonhosted.org/packages/d1/03/3f60a22217f6450a1258471d6313f558cfdb5c804e279b24af04c70f74d0/rhkpy-1.3.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-21 13:49:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zrbyte",
"github_project": "rhkpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "rhkpy"
}
