Skip to main content

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

PyTASER

PyTASER Docs

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.1.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.1.0
File Size Uploaded Provenance Actions
pytaser-1.1.0.tar.gz 13.2 MB Without provenance Details for pytaser-1.1.0.tar.gz

Built distribution (wheel)

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

Total release size: 13.2 MB

Release files / pytaser-1.1.0.tar.gz

Download URL pytaser-1.1.0.tar.gz
Size 13.2 MB
Tags Source
SHA-256 checksum
How to use checksums
725a8019c985b3d103c9978e76d9284c93d67fd551a9e9c5942f6603bb95a90a
BLAKE2b-256 checksum
How to use checksums
7f9c919e3f63e2dbd9101b46196a08c59e62045e9311f70c03227e3081c85b44
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

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

Download URL pytaser-1.1.0-py3-none-any.whl
Size 27.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
47e50ccd6c284d43191c90d8d9f76765f5eaf7f2fe47ea417819e28250e3ff0d
BLAKE2b-256 checksum
How to use checksums
d59da64e49f006c65ae414a41ec79fd06961bf2be7433f41179d50b0629d4755
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Security for pytaser 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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