Metadata-Version: 2.1
Name: qspec
Version: 0.1.1
Summary: A python package for calculations surrounding Collinear Laser Spectroscopy.
Author-email: Patrick Mueller <pamueller@ikp.tu-darmstadt.de>
Maintainer-email: Patrick Mueller <pamueller@ikp.tu-darmstadt.de>
License: MIT License
        
        Copyright (c) 2022 Patrick Müller
        
        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.
        
Project-URL: homepage, https://www.ikp.tu-darmstadt.de/forschung_kernphysik/gruppen_kernphysik/experiment/ag_w_noertershaeuser/index.en.jsp
Project-URL: repository, http://gitlab.ikp.physik.tu-darmstadt.de/Lasersphere/qspec
Project-URL: bug-tracker, http://gitlab.ikp.physik.tu-darmstadt.de/Lasersphere/qspec/issues
Keywords: physics,laser spectroscopy,simulation,quantum mechanics,data analysis
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

qspec
=====

A python package for calculations surrounding Collinear Laser Spectroscopy.

The [_qspec_](https://github.com/lasersphere/qspec) Python package provides mathematical and physical functions
frequently used in laser spectroscopy but also more general methods for data processing. 
Most functions are compatible with numpy arrays and are able to process n-dimensional arrays,
even in the case of arrays of vector- or matrix-objects. This enables fast calculations with large samples of data,
e.g., facilitating Monte-Carlo simulations.

Exemplary, two exciting use cases could be:
- Coherently evolve atomic state population in a classical laser field. 
In contrast to powerful packages such as [_qutip_](https://qutip.org/),
the quantum mechanical system is set up automatically by just providing atomic state and laser information.
- Generate modular lineshape models for fitting. The modular system can be used
to sum, convolve, link models and share parameters, fit hyperfine structure spectra, etc.


### Included modules

- _tools_: General helper, print, data shaping and mathematical functions.
- _stats_: Contains functions for the statistical analysis of data.
- _physics_: Library of physical functions.
- _algebra_: Contains functions to calculate dipole coefficients and Wigner-j symbols.
- _analyze_: Contains optimization functions and a class for King-plots.
- _lineshapes_: A framework to generate modular lineshape models for fitting.
- _simulate_: An intuitive framework to simulate laser-atom interactions.
