# NanofinderParser
----
[![Documentation Status](https://readthedocs.org/projects/nanofinderparser/badge/?version=stable)](https://nanofinderparser.readthedocs.io/en/stable/)
[![PyPI - Version](<https://img.shields.io/pypi/v/nanofinderparser.svg?logo=pypi&label=PyPI&logoColor=gold>)](<https://pypi.python.org/pypi/nanofinderparser>)
[![License - BSD-3-Clause](<https://img.shields.io/pypi/l/nanofinderparser.svg>)](<https://spdx.org/licenses/BSD-3-Clause.html>)
Parse and process Raman and photoluminescence (PL) data files generated by Nanofinder instruments.
## Features
- Parse SMD (Scanned Measurement Data) files produced by NanoFinder instruments
- Convert spectral data between different units (nm, cm<sup>-1</sup>, eV, Raman shift)
- Export parsed data to CSV files or pandas DataFrames
## Installation
You can install NanofinderParser using pip:
```bash
pip install nanofinderparser
```
Or using Poetry:
```bash
poetry add nanofinderparser
```
## Quick Start
Here's a simple example of how to use NanofinderParser in python:
```python
from pathlib import Path
from nanofinderparser import load_smd
# Load an SMD file
file_path = Path("path/to/your/smd/file.smd")
mapping_data = load_smd(file_path)
# Access basic information
print(f"Laser wavelength: {mapping_data.laser_wavelength} nm")
print(f"Map size: {mapping_data.map_size}")
# Export data to CSV
mapping_data.to_csv(path=Path("output"), spectral_units="raman_shift")
```
You can also use NanofinderParser from the command line:
```shell
# Convert an SMD file to CSV
nanofinderparser convert path/to/your/smd/file.smd output_folder --units nm
# Display information about an SMD file
nanofinderparser info path/to/your/smd/file.smd
```
For more detailed usage instructions, please refer to the [documentation](https://nanofinderparser.readthedocs.io/).
Raw data
{
"_id": null,
"home_page": "https://github.com/psolsfer/nanofinderparser",
"name": "nanofinderparser",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "nanofinderparser",
"author": "Pablo Sol\u00eds-Fern\u00e1ndez",
"author_email": "psolsfer@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0b/6a/ea64aa33b6db8cd45f9c53ae49b35f6ea3360d11db1b7e1ab02bf61ef081/nanofinderparser-0.3.5.tar.gz",
"platform": null,
"description": "# NanofinderParser\n\n----\n\n[![Documentation Status](https://readthedocs.org/projects/nanofinderparser/badge/?version=stable)](https://nanofinderparser.readthedocs.io/en/stable/)\n[![PyPI - Version](<https://img.shields.io/pypi/v/nanofinderparser.svg?logo=pypi&label=PyPI&logoColor=gold>)](<https://pypi.python.org/pypi/nanofinderparser>)\n[![License - BSD-3-Clause](<https://img.shields.io/pypi/l/nanofinderparser.svg>)](<https://spdx.org/licenses/BSD-3-Clause.html>)\n\nParse and process Raman and photoluminescence (PL) data files generated by Nanofinder instruments.\n\n\n\n\n## Features\n\n- Parse SMD (Scanned Measurement Data) files produced by NanoFinder instruments\n- Convert spectral data between different units (nm, cm<sup>-1</sup>, eV, Raman shift)\n- Export parsed data to CSV files or pandas DataFrames\n\n## Installation\n\nYou can install NanofinderParser using pip:\n\n```bash\npip install nanofinderparser\n```\n\nOr using Poetry:\n\n```bash\npoetry add nanofinderparser\n```\n\n## Quick Start\n\nHere's a simple example of how to use NanofinderParser in python:\n\n```python\nfrom pathlib import Path\nfrom nanofinderparser import load_smd\n\n# Load an SMD file\nfile_path = Path(\"path/to/your/smd/file.smd\")\nmapping_data = load_smd(file_path)\n\n# Access basic information\nprint(f\"Laser wavelength: {mapping_data.laser_wavelength} nm\")\nprint(f\"Map size: {mapping_data.map_size}\")\n\n# Export data to CSV\nmapping_data.to_csv(path=Path(\"output\"), spectral_units=\"raman_shift\")\n```\n\nYou can also use NanofinderParser from the command line:\n\n```shell\n# Convert an SMD file to CSV\nnanofinderparser convert path/to/your/smd/file.smd output_folder --units nm\n\n# Display information about an SMD file\nnanofinderparser info path/to/your/smd/file.smd\n```\n\nFor more detailed usage instructions, please refer to the [documentation](https://nanofinderparser.readthedocs.io/).\n\n\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Parse and process Raman and photoluminescence (PL) data files generated by Nanofinder instruments.",
"version": "0.3.5",
"project_urls": {
"Documentation": "https://nanofinderparser.readthedocs.io",
"Homepage": "https://github.com/psolsfer/nanofinderparser",
"Repository": "https://github.com/psolsfer/nanofinderparser"
},
"split_keywords": [
"nanofinderparser"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3edc1328f169ced4c991fee49f6541d2bc85a2145b6c3e2739df10afe7a38f8",
"md5": "3e6519b57c1f52cc3384f8ac1350a807",
"sha256": "f1bac34d81cc899636a2f54c243607c21f33b49fbc20565be0336ea7ef7e0c91"
},
"downloads": -1,
"filename": "nanofinderparser-0.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e6519b57c1f52cc3384f8ac1350a807",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 18470,
"upload_time": "2024-11-08T05:14:41",
"upload_time_iso_8601": "2024-11-08T05:14:41.366604Z",
"url": "https://files.pythonhosted.org/packages/d3/ed/c1328f169ced4c991fee49f6541d2bc85a2145b6c3e2739df10afe7a38f8/nanofinderparser-0.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b6aea64aa33b6db8cd45f9c53ae49b35f6ea3360d11db1b7e1ab02bf61ef081",
"md5": "7529fb7ecb5e57804378b31a2788dd11",
"sha256": "91a8f2cc27886fb1a6638dddb2603f95c1de7a0b2952ca258d39b3b1cfa95866"
},
"downloads": -1,
"filename": "nanofinderparser-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "7529fb7ecb5e57804378b31a2788dd11",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 16917,
"upload_time": "2024-11-08T05:14:43",
"upload_time_iso_8601": "2024-11-08T05:14:43.026450Z",
"url": "https://files.pythonhosted.org/packages/0b/6a/ea64aa33b6db8cd45f9c53ae49b35f6ea3360d11db1b7e1ab02bf61ef081/nanofinderparser-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-08 05:14:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "psolsfer",
"github_project": "nanofinderparser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "nanofinderparser"
}