Skip to main content

ramansep

PyPI DOI tests

Separate strain from carrier density in Raman maps of 2D materials, using two phonon modes whose lever arms differ.

A single Raman frequency responds to strain and to carrier density at once, so one mode cannot tell the two apart. Two modes with sufficiently different responses form a linear, invertible probe: measure both shift maps, invert a 2x2 matrix per pixel, and obtain a strain map and a carrier-density map with propagated uncertainties.

Status

v0.3.0 (alpha). The inversion core, uncertainty propagation, conditioning diagnostics, a synthetic end-to-end example, two cited coefficient sets for monolayer MoS2, and a cited graphene G + 2D set are implemented and tested. The API may change before v1.0.

Cited coefficient sets (new in v0.2)

Two example sets for monolayer 1H-MoS2 ship with full provenance, and the test-suite reproduces the published separation results of the source paper from them (edge charge of 2.3e12 cm^-2 from a 0.5 cm^-1 A'1 redshift with 2LA(M) unmoved; 0.134% interior tension carrying no significant charge):

  • mos2_a1_2la(): the A'1 + 2LA(M) pair of the source paper. Strain lever arms -5.1 and -20.9 cm^-1 per percent of biaxial strain (frozen-phonon DFT, ratio 4.1); A'1 doping coefficient -2.2 cm^-1 per 1e13 cm^-2 of electrons (measured, Chakraborty et al., Phys. Rev. B 85, 161403(R) (2012)). The 2LA(M) doping coefficient is unmeasured and set to zero; the source paper bounds the consequence of that choice at 16% of a recovered edge charge.
  • mos2_eprime_a1(): the historically used all-optical E' + A'1 pair, built from the measured biaxial Grueneisen parameters of Michail et al., ACS Appl. Mater. Interfaces 16, 49602 (2024). Both optical modes respond weakly to strain, so for equal shift noise this pair returns about five times the strain uncertainty of the A'1 + 2LA(M) pair; it is included for comparison and for workflows where the overtone is not available.

New in v0.3, graphene_g_2d_lee2012(): the G + 2D pair of monolayer graphene, expressing the vector decomposition of Lee et al., Nat. Commun. 3, 1024 (2012) as a linear inversion. Strain axis: -23.5 cm^-1 per percent of randomly oriented uniaxial strain with the measured 2D/G slope of 2.2 +/- 0.2; hole-doping axis: the measured slope 0.70 +/- 0.05. The doping output of this set is deliberately NOT a carrier density but the G-band shift attributable to hole doping (cm^-1): the G-mode doping response of graphene is nonlinear and sign-dependent, so no universal linear per-density rate exists to ship, and the docstring points to the gated calibrations (Froehlicher and Berciaud, Phys. Rev. B 91, 205413 (2015)) a user needs for the conversion on their own substrate.

Each function's docstring states which number comes from which source and the conditions of applicability (for MoS2: 1H monolayer, SiO2-supported, 300 K; 532 nm for the disorder-activated calibration). Check that your sample matches before use.

What this package deliberately does not include

No constants beyond the three documented sets are shipped. Lever arms depend on material, mode pair, excitation wavelength and substrate; a measurement tool that ships unverified constants propagates wrong results. For any other system you provide a ModeCoefficients from the literature or your own calibration, and the reference field is mandatory so the provenance of every number travels with the analysis.

Install

pip install ramansep

For development, clone the repository and pip install -e .[test].

Use

import numpy as np
from ramansep import SeparationModel, ModeCoefficients

coeffs = ModeCoefficients(
    mode1_name="A'1", mode2_name="2LA(M)",
    k1_strain=...,   # cm^-1 per unit strain, from your calibration
    k1_density=...,  # cm^-1 per unit carrier density
    k2_strain=...,
    k2_density=...,
    reference="cite the source of these numbers",
)
model = SeparationModel(coeffs)
result = model.invert(dw_mode1, dw_mode2, sigma1=0.1, sigma2=0.1)
# result.strain, result.density, result.strain_sigma, result.density_sigma

SeparationModel warns when the mode pair is poorly conditioned, i.e. when the two modes respond too similarly for a reliable separation.

Method

The method of using the first-order A'1 mode together with the disorder-activated 2LA(M) overtone, whose strain lever arms differ severalfold while only A'1 responds appreciably to carrier density, is developed in:

T. M. Mahim and M. M. Rahman, "Two Raman phonons quantify the fixed edge charge left by patterning monolayer transition metal dichalcogenides" (under review). Code for the paper itself: https://github.com/Tanvir-Mahmud-Mahim/Width-scaling-in-monolayer-semiconductor-nanoribbon-transistors

This package is the general-purpose, material-agnostic inversion tool; the paper repository reproduces the specific published study.

Peak fitting (new in v0.4)

The roadmap's front end is in: fit_two_modes takes a raw spectrum, fits a Lorentzian to each mode window with a NumPy-only Levenberg-Marquardt solver (analytic Jacobians, linearized 1-sigma uncertainties), and returns exactly the shifts and uncertainties that SeparationModel.invert consumes.

from ramansep import SeparationModel, fit_two_modes, mos2_a1_2la

model = SeparationModel(mos2_a1_2la())
dw1, dw2, s1, s2, fit1, fit2 = fit_two_modes(
    wavenumber, counts,
    window1=(395.0, 415.0), window2=(440.0, 465.0),
    ref1=404.7, ref2=452.0)   # your pristine references
result = model.invert(dw1, dw2, s1, s2)

The fitter is deliberately Lorentzian-only: that is the lifetime lineshape of a phonon, and an instrument-dominated line deserves a Voigt treatment this package does not yet pretend to have. The test suite checks the analytic Jacobian against finite differences, exact parameter recovery on noiseless lines, statistical compatibility of the reported center uncertainty with the actual scatter on noisy lines, and a full spectrum-to-inversion round trip.

Roadmap

  • v0.2 (done): documented example coefficient sets with citations
  • v0.3 (done): graphene G+2D coefficient set (Lee 2012)
  • v0.4 (done): peak-fitting front end (fit the two modes, feed the inversion)
  • v0.5: joint Bayesian inversion with spatial priors

Support and governance

The package is written and maintained by Tanvir Mahmud Mahim (Department of Electrical and Electronic Engineering, BRAC University), who reviews every change and takes the final decision on scope and releases. There is no separate governance body; design questions are discussed in the open in issues and pull requests, and the standing rule of CONTRIBUTING.md binds the maintainer exactly as it binds contributors: a change that touches physics arrives with a test, and a constant arrives with its source.

Support runs through the issue tracker at https://github.com/TaN-MM-Org/ramansep/issues. Usage questions are welcome there alongside bug reports; a docstring that left a unit or a sign convention unclear is treated as a documentation bug, not as user error. The maintainer aims to respond within a week.

While the version is below 1.0 the API may still move between minor versions; such changes are called out in the release notes, and the roadmap above states what is planned, so that a user can tell a missing feature from an omission by design.

License

Apache-2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ramansep-0.4.0.tar.gz (24.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ramansep-0.4.0-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

Details for the file ramansep-0.4.0.tar.gz.

File metadata

  • Download URL: ramansep-0.4.0.tar.gz
  • Upload date:
  • Size: 24.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ramansep-0.4.0.tar.gz
Algorithm Hash digest
SHA256 01f19484a39b4e5dc61e2a94e713956defc2f050af1217b03ef0aad5303f79a4
MD5 555b0f93123ad9e61ed9a736dc34e888
BLAKE2b-256 74fdaeda2c7fbfcd532c72089fdfa96db712ee1d61766f7a0054bc90643686de

See more details on using hashes here.

Provenance

The following attestation bundles were made for ramansep-0.4.0.tar.gz:

Publisher: publish.yml on TaN-MM-Org/ramansep

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ramansep-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: ramansep-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ramansep-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be51ef325d5e19733a8b74717b78c37b7ee55b2be6173d527090701815a72679
MD5 21527f293dc7252d7d5c6f0270dad51c
BLAKE2b-256 7c6f42ce5d8f78da5fdfa8a045fc48fdebddb1aa67f9957cc4fbe5e4ec7791c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for ramansep-0.4.0-py3-none-any.whl:

Publisher: publish.yml on TaN-MM-Org/ramansep

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.6.0

2 files

0.5.0

2 files

This release

0.4.0 This release

2 files

0.3.0

2 files

0.2.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page