NanofinderParser

GitHub · PyPI · Docs · Issues

Parse and process Raman and photoluminescence (PL) data files generated by Nanofinder instruments.

Features

• Parse SMD (Scanned Measurement Data) mapping files produced by NanoFinder instruments
• Parse MDT files, which hold individual spectra and 2-D maps rather than a mapping
• Convert spectral data between different units (nm, cm^-1, eV, Raman shift)
• Export parsed data to CSV files or pandas DataFrames

Installation

From PyPI

pip install nanofinderparser

or

uv add nanofinderparser

From Source

git clone https://github.com/psolsfer/nanofinderparser.git
cd nanofinderparser
uv sync

Usage

Quick Start

Here's a simple example of how to use NanofinderParser in 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")

Individual spectra are saved by NanoFinder as MDT files, which are loaded with load_mdt:

from pathlib import Path
from nanofinderparser import load_mdt

spectra = load_mdt(Path("path/to/your/mdt/file.mdt"))

for spectrum in spectra:
    print(spectrum.title, spectrum.get_spectral_axis("raman_shift"), spectrum.data)

You can also use NanofinderParser from the command line:

# Convert an SMD file to CSV
nanofinderparser convert path/to/your/smd/file.smd output_folder --units nm

# Convert an MDT file of individual spectra to CSV
nanofinderparser convert-mdt path/to/your/mdt/file.mdt output_folder --units nm

# Display information about a file
nanofinderparser info path/to/your/smd/file.smd
nanofinderparser info-mdt path/to/your/mdt/file.mdt

For more detailed usage instructions, please refer to the documentation.

Command Line Interface

nanofinderparser --help

Python API

import nanofinderparser

# TODO: Add usage examples

Development

Setup

git clone https://github.com/psolsfer/nanofinderparser.git
cd nanofinderparser
uv sync

Install the prek git hook

uv run prek install

Running Tests

uv run pytest

Code Quality

uv run ruff check .
uv run ruff format .
uv run mypy src/nanofinderparser

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Credits

This package was created with Copier and the Copier PyPackage uv project template.