Skip to main content

Documentation Status made-with-python License: MIT tests pypi black

PyTASER

The library is undergoing changes before it is released

Official Documentation

PyTASER is a Python (3.9+) library built for simulating transient absorption spectroscopy (TAS) features from DFT calculations. The goal of this library is to simulate TAS spectra for comparison with and interpretation of experimental spectra. The main features include:

  • A TAS spectrum for a pristine semiconducting crystal
  • Components from individual band-to-band transitions
  • Spectra for different conditions: temperature and carrier concentrations
  • Consideration of non-magnetic and magnetic materials
  • Capability to input calculated bandstructure and density of states inputs with support for the Materials Project

Installation

To install the module with pip (recommended):

pip install --user pytaser

To install directly from the git repository:

pip install --user git+https://github.com/WMD-group/PyTASER

To do a manual build and installation:

python3 setup.py build
python3 setup.py install --user

PyTASER is currently compatible with Python 3.9+ and relies on a number of open-source python packages, specifically:

Developer’s installation (optional)

For development work, PyTASER can also be installed from a copy of the source directory:

Download PyTASER source code using the command:

git clone https://github.com/WMD-group/PyTASER

Navigate to root directory:

cd PyTASER

Install the code with the command:

pip install -e .

This command tries to obtain the required packages and their dependencies and install them automatically.

Visualisation

The preferred method is to generate a Jupyter Notebook, as shown in the examples folder. Alternatively, you can set up a file in Python to run it in the command line of the terminal:

python3 <filename.py>

Contributing

We appreciate any contributions in the form of a pull request. Additional test cases/example spectra performed with PyTASER would be welcomed. Please feel free to reach out to us if there are any questions or suggestions.

Future topics we plan to build on:

  • Incorporating finite-temperature effects (particularly for indirect bandgaps)
  • Description of more complex optical processes (e.g. stimulated emission)
  • Direct treatment of pump-probe time delay
  • Incorporating spin-flip processes for spin-polarised systems
  • Description of defective crystals

Acknowledgements

The project was the focus of a UROP by @savya10, supervised by @utf and @aronwalsh, with on-going developments and testing from @kavanase and @youngwonwoo.

Metadata

Release files for pytaser 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytaser 1.0.0
File Size Uploaded
pytaser-1.0.0.tar.gz 10.2 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for pytaser 1.0.0
File Interpreter ABI Platform
pytaser-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 10.3 MB

Release files / pytaser-1.0.0.tar.gz

Download URL pytaser-1.0.0.tar.gz
Size 10.2 MB
Tags Source
SHA-256 checksum
How to use checksums
8c80f195f0c83562e94be12b3d9fdb0f0306a25b5fad837771c71ccfc3a964cd
BLAKE2b-256 checksum
How to use checksums
d579b131e5a3b089122a7818d4920d7acb3461006b816c331e367f8c8a52a1f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release files / pytaser-1.0.0-py3-none-any.whl

Download URL pytaser-1.0.0-py3-none-any.whl
Size 27.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2564a08fbca2aec35803082cef2fa3a57af0de3dd30b73644bdc891bcd4e4c81
BLAKE2b-256 checksum
How to use checksums
0004352e84c015906f7c26c2208f9964c5089d809027e97c27fbff366168ac62
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Release history Release notifications | RSS feed

2.3.1

2 release files

2.3.0

2 release files

2.2.0

2 release files

2.1.4

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.1.0

2 release files

This release

1.0.0 This release

2 release files

0.1.0

2 release 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