Skip to main content

Distributed data processing routines for multidimensional photoemission spectroscopy (MPES)

Project description

mpes

Build Status License Downloads

Distributed data processing routines for multidimensional photoemission spectroscopy (MPES), an upgrade of the angle-resolved photoemission spectroscopy (ARPES) to achieve parallel data acquisition on multiple parameters by the use of a time-of-flight tube and a multichannel delay-line detector.

Banner

In a photoemission process, an extreme UV or X-ray photon liberates an electron from the confines of the electronic potential within the material. ARPES directly measures the electronic energy and momentum parallel to the surface of the sample under study to infer the electronic states of the material. For a tutorial review on ARPES and its applications in physics and material science, see here. The data structure of ARPES is a stack of 2D images measured at different sample geometries, which are used to reconstruct the full static 3D band structure of the material.

The MPES instrument enables sampling of the multidimensional parameter space associated with the electronic band structure at an elevated speed. At the minimum, it measures the two parallel momenta and the energy of photoelectrons simultaneously. The measurement procedure can be extended with recording of varying external parameters such as the temperature, photon polarization, dynamical time delay as in a time-resolved ARPES (trARPES) experiments using a ultrafast laser system (~ fs resolution), etc. These different flavors of momentum-resolved photoemission experiment together yield a complete understanding of the electronic properties of materials under equilibrium and nonequilibrium conditions for realistic design and simulation of electronic devices.

Installation

  1. Install from scratch

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

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

     pip install mpes
     
  4. Install a specific version

     # version 1.0.9 from PyPI
     pip install mpes==1.0.9
    
     # version 0.9.8 from GitHub
     pip install --upgrade git+https://github.com/mpes-kit/mpes.git@0.9.8
     

Documentation and tutorials

Documentation on the usage is posted here and examples are provided in Jupyter notebooks.

List of current tutorials are viewable using nbviewer via the links

The size of the single-event datasets used in the tutorial notebooks are in the GB to TB range each, which reflect the actual examperimental setting and the light source configuration (see here for technical details). Example datasets are made available publicly in a Zenodo repository. Please always use the latest version of the datasets.

Reference

If you want to refer the software in your work, please cite the following paper.

R. P. Xian, Y. Acremann, S. Y. Agustsson, M. Dendzik, K. Bühlmann, D. Curcio, D. Kutnyakhov, F. Pressacco, M. Heber, S. Dong, T. Pincelli, J. Demsar, W. Wurth, P. Hofmann, M.Wolf, M. Scheidgen, L. Rettig, R. Ernstorfer, An open-source, end-to-end workflow for multidimensional photoemission spectroscopy, Sci. Data 7, 442 (2020).

Specifically, for the symmetry distortion correction, please cite

R. P. Xian, L. Rettig, R. Ernstorfer, Symmetry-guided nonrigid registration: The case for distortion correction in multidimensional photoemission spectroscopy, Ultramicroscopy 202, 133 (2019).

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

mpes-1.1.4.tar.gz (6.7 MB view details)

Uploaded Source

Built Distribution

mpes-1.1.4-py2.py3-none-any.whl (104.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file mpes-1.1.4.tar.gz.

File metadata

  • Download URL: mpes-1.1.4.tar.gz
  • Upload date:
  • Size: 6.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.3

File hashes

Hashes for mpes-1.1.4.tar.gz
Algorithm Hash digest
SHA256 95469af0d015f305a5f308fd6caefafa18f16cc6b1d40f7e7dd751e94d0862c1
MD5 c4455ffb7716c58f74bc9b260f6bb969
BLAKE2b-256 f3b272fa4f2d41680fb631f7324c16103becf193dcace735e363080a8bf3086d

See more details on using hashes here.

File details

Details for the file mpes-1.1.4-py2.py3-none-any.whl.

File metadata

  • Download URL: mpes-1.1.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 104.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.3

File hashes

Hashes for mpes-1.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fa72d9ad658428c1c40536dd640b01ad8c1120c5af706c2245a15d91971a1e51
MD5 68b3ffb8ac4e47dbf4703d1c4dfd2bac
BLAKE2b-256 99ae76297dddd5816bdd939a80c5bc796eb65b07f343e68b8b0e35fa2905a6eb

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