Skip to main content

Multiband lineshape fitting routines for photoemission spectroscopy

Project description

pesfit

License Downloads PyPI version

Scalable distributed multicomponent lineshape fitting routines and benchmarks for spectral or spectrum-like data

Rationale

Lineshape fitting is a universal task in photoemission spectroscopy and can be a tedious endeavor due to the increasing amount of data measured in modern instruments (e.g. angle-resolved hemispherical analyzer, time-of-flight electron momentum microscope). It extracts physically meaningful quantities directly related to the materials' electronic properties, which can be reproduced from theory calculations. However, the efficiency bottleneck in lineshape fitting puts constraints on the potential new physical insights obtainable within a meaningful time frame. We set up here examples of multiband photoemission spectra along with existing domain knowledge in the field. The routines and benchmarks featured here offer an open-source data and algorithm platform for continuous algorithm development to improve the computational efficiency of the lineshape fitting task, which, in the meantime, also paves the way towards the automation of materials characterization using photoemission spectroscopy.

Design and scope

The fitting part of the package builds and improves on the existing Model and CompositeModel classes in the widely-used lmfit package to include multiband lineshapes (involving an arbitrary number of peaks) evaluated using map-reduce operations. Fitting of many intensity profiles (i.e. line spectra) can be carried out either in sequence or in parallel (built in using dask and multiprocessing).

The focus of the software and its benchmarks in on determining the momentum-dependent band positions in valence band photoemission data at scale (e.g. 104-105 spectra with each containing 10+ bands), which meets the needs for a global understanding of these complex data with reasonable accuracy (not necessarily accounting for all photoemission physics) to yield empirical structural information (i.e. band structure parameters). For conventional data analysis of core-level photoemission spectroscopy that often exhibits a complex background, please consult software packages such as lmfit, xps, and gxps.

Installation

  1. Install from scratch

     pip install git+https://github.com/mpes-kit/pesfit.git 
  2. Upgrade or overwrite an existing installation

     pip install --upgrade git+https://github.com/mpes-kit/pesfit.git 
  3. Install from PyPI

     pip install pesfit 

Data source

Please download the data from mpes-kit/pesarxiv. To run the examples and benchmarks, create a ./data folder in the cloned repository and copy the downloaded data into it.

Benchmarks and examples

Besides source code, the package comes with examples presented in Jupyter notebooks and benchmarks for multiband dispersion fitting routines in scripts, using the data described above.

Documentation

Online documentation is provided here.

Reference

Please cite the following paper if you want to refer to the software:

R. Patrick Xian, R. Ernstorfer, Philipp M. Pelz, Scalable multicomponent spectral analysis for high-throughput data annotation, arXiv: 2102.05604.

Project details


Download files

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

Source Distribution

pesfit-0.6.6.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

pesfit-0.6.6-py2.py3-none-any.whl (22.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pesfit-0.6.6.tar.gz.

File metadata

  • Download URL: pesfit-0.6.6.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/47.1.1 requests-toolbelt/0.8.0 tqdm/4.56.0 CPython/3.6.4

File hashes

Hashes for pesfit-0.6.6.tar.gz
Algorithm Hash digest
SHA256 d508e9f9efa6384f8ed7a12306fc25bf0fc35f5cfe4a7d96c4dba17a08a69906
MD5 1676fea7bc2f358b2bf441fac7ea9ddd
BLAKE2b-256 9148c9256c69eb9246189185696c22801ee8a4aa1f0fb87ae9cf5717ed817199

See more details on using hashes here.

File details

Details for the file pesfit-0.6.6-py2.py3-none-any.whl.

File metadata

  • Download URL: pesfit-0.6.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 22.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/47.1.1 requests-toolbelt/0.8.0 tqdm/4.56.0 CPython/3.6.4

File hashes

Hashes for pesfit-0.6.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4c478c6e5fad3e71678bcc0f0a1d279c815a7b690b4a65382b655857c5e4f107
MD5 f55089a2d86ea3f38917875a82c7b63d
BLAKE2b-256 90ff311eb9ae0cc7501a89b4f4f99a9fc550c4fa94b4a3aaef32fbe0645a12a4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page