Metadata-Version: 2.5
Name: lasers
Version: 0.0.3
Summary: A Python library of laser physics equations for researchers and engineers.
Project-URL: Homepage, https://github.com/tylerteichmann/lasers
Project-URL: Source, https://github.com/tylerteichmann/lasers
Project-URL: Bug Tracker, https://github.com/tylerteichmann/lasers/issues
Author-email: Tyler Teichmann <tyler.j.teichmann@gmail.com>
License: MIT License
        
        Copyright (c) 2026 
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: BPP,M-squared,beam parameter product,beam quality,fluence,laser,optics,photonics,spectral linewidth
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: numpy>=2.1
Requires-Dist: scipy>=1.15
Provides-Extra: dev
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: scipy-stubs; extra == 'dev'
Description-Content-Type: text/markdown

# lasers

A Python library of laser physics equations for researchers and engineers.

[![PyPI version](https://img.shields.io/pypi/v/lasers.svg)](https://pypi.org/project/lasers/)
[![Python](https://img.shields.io/pypi/pyversions/lasers.svg)](https://pypi.org/project/lasers/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![CI](https://github.com/tylerteichmann/lasers/actions/workflows/ci.yaml/badge.svg)](https://github.com/tylerteichmann/lasers/actions/workflows/ci.yaml)

## Installation

```bash
$ pip install lasers
```

## Usage

```python
import lasers as lz

dnu = lz.spectral_linewidth(linewidth=168e-12, center_wavelength=777.783e-9)
BPP = lz.beam_parameter_product(beam_waist=1.5e-3, divergence=0.5e-3)
m2 = lz.m_squared(beam_parameter_product=BPP, wavelength=1064e-9)
F = lz.peak_fluence(pulse_energy=100e-3, beam_radius=1e-2)
```

## Overview

`lasers` is a Python library for laser physicists and optical engineers, providing
well-documented implementations of equations and computational tools commonly
encountered in laser science and engineering.

The design philosophy prioritizes accessibility to scientists over software
convention. Function signatures and parameter names reflect the terminology
established in standard references — Siegman, Saleh & Teich, Boyd — so that
the interface reads naturally to anyone trained in the field. Inputs and outputs
use SI units throughout.

`lasers` is intended to serve both interactive and programmatic use cases.
Individual functions support rapid estimation and verification during
experimental work, while the broader API accommodates integration into parameter
studies, system-level models, and automated analysis pipelines.

The library is under active development. Its scope will continue to expand to
reflect the breadth of analytical methods used across the optics and photonics
community. Contributions, feature requests, and domain expertise are welcomed.

## Contributing

Bug reports and feature requests are welcome via [GitHub Issues](https://github.com/tylerteichmann/lasers/issues).

## Development

```bash
pip install -e ".[dev]"
```

## Citation

If you use this package in published work, please cite it:

```bibtex
@software{teichmann_lasers,
  author  = {Teichmann, Tyler},
  title   = {lasers: A Python library of laser physics equations},
  url     = {https://github.com/tylerteichmann/lasers},
  version = {0.0.2},
}
```

## Authors

[Tyler Teichmann](https://github.com/tylerteichmann)

## License

MIT — see [LICENSE](LICENSE).
