| Name | qspec JSON |
| Version |
0.3.6
JSON |
| download |
| home_page | None |
| Summary | Physics toolbox for laser spectroscopy |
| upload_time | 2024-12-17 02:07:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2022 - 2024 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. |
| keywords |
physics
laser spectroscopy
simulation
quantum mechanics
data analysis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
matplotlib
numpy
scipy
sympy
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1>
<img src="https://raw.githubusercontent.com/patmlr/qspec/refs/heads/dev-jekyll/docs/assets/img/logo.svg" width="300">
</h1><hr>
[](https://www.microsoft.com)
[](https://www.python.org/)
[](https://opensource.org/license/mit)
[](https://doi.org/10.48550/arXiv.2409.01417)
[](https://arxiv.org/abs/2409.01417)
The [_qspec_](https://pypi.org/project/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.
This enables fast calculations with large samples of data, e.g., facilitating Monte-Carlo simulations.
Tutorials and the API documentation are available on the [_Homepage_](https://patmlr.github.io/qspec/).
Additional example scripts can be found in the example folder on [_GitHub_](https://github.com/patmlr/qspec).
### Dependencies
- [_Matplotlib_](http://matplotlib.org/)
- [_NumPy_](http://www.numpy.org/)
- [_SciPy_](http://www.scipy.org/)
- [_SymPy_](http://www.sympy.org/)
### Modules
- _algebra_: Contains functions to calculate dipole coefficients and Wigner-*j* symbols.
- _analyze_: Contains optimization functions and a class for King-plots.
- _models_: Framework to generate modular fit models.
- _physics_: Library of physical functions.
- _simulate_: Intuitive framework to simulate coherent laser-atom interactions.
- _stats_: Contains functions for the statistical analysis of data.
- _tools_: General helper, print, data shaping and mathematical functions.
### Exemplary use cases
- Calculate frequently used physical observables such as kinetic energies, velocities, Doppler shifts,
hyperfine structure splittings, etc.
- 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. This module is similar to the [_satlas2_](https://iks-nm.github.io/satlas2/) Python package.
- Perform multidimensional King-plot analyses.
Raw data
{
"_id": null,
"home_page": null,
"name": "qspec",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "physics, laser spectroscopy, simulation, quantum mechanics, data analysis",
"author": null,
"author_email": "Patrick M\u00fcller <pmueller@physics.ucla.edu>",
"download_url": "https://files.pythonhosted.org/packages/a1/a5/5d59d2a219d18b80b0a39b61f7ebb71482b62b86f87a0e7dbcb0f1e5d595/qspec-0.3.6.tar.gz",
"platform": null,
"description": "<h1>\r\n<img src=\"https://raw.githubusercontent.com/patmlr/qspec/refs/heads/dev-jekyll/docs/assets/img/logo.svg\" width=\"300\">\r\n</h1><hr>\r\n\r\n[](https://www.microsoft.com)\r\n[](https://www.python.org/)\r\n[](https://opensource.org/license/mit)\r\n\r\n[](https://doi.org/10.48550/arXiv.2409.01417)\r\n[](https://arxiv.org/abs/2409.01417)\r\n\r\nThe [_qspec_](https://pypi.org/project/qspec/) Python package provides mathematical and physical functions\r\nfrequently used in laser spectroscopy but also more general methods for data processing. \r\nMost functions are compatible with numpy arrays and are able to process *n*-dimensional arrays.\r\nThis enables fast calculations with large samples of data, e.g., facilitating Monte-Carlo simulations.\r\nTutorials and the API documentation are available on the [_Homepage_](https://patmlr.github.io/qspec/).\r\nAdditional example scripts can be found in the example folder on [_GitHub_](https://github.com/patmlr/qspec).\r\n\r\n### Dependencies\r\n\r\n- [_Matplotlib_](http://matplotlib.org/)\r\n- [_NumPy_](http://www.numpy.org/)\r\n- [_SciPy_](http://www.scipy.org/)\r\n- [_SymPy_](http://www.sympy.org/)\r\n\r\n### Modules\r\n\r\n- _algebra_: Contains functions to calculate dipole coefficients and Wigner-*j* symbols.\r\n- _analyze_: Contains optimization functions and a class for King-plots.\r\n- _models_: Framework to generate modular fit models.\r\n- _physics_: Library of physical functions.\r\n- _simulate_: Intuitive framework to simulate coherent laser-atom interactions.\r\n- _stats_: Contains functions for the statistical analysis of data.\r\n- _tools_: General helper, print, data shaping and mathematical functions.\r\n\r\n### Exemplary use cases\r\n- Calculate frequently used physical observables such as kinetic energies, velocities, Doppler shifts, \r\nhyperfine structure splittings, etc.\r\n- Coherently evolve atomic state population in a classical laser field. \r\nIn contrast to powerful packages such as [_qutip_](https://qutip.org/),\r\nthe quantum mechanical system is set up automatically by just providing atomic state and laser information.\r\n- Generate modular lineshape models for fitting. The modular system can be used\r\nto sum, convolve, link models and share parameters, fit hyperfine structure spectra, etc. This module is similar to the [_satlas2_](https://iks-nm.github.io/satlas2/) Python package.\r\n- Perform multidimensional King-plot analyses.\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 - 2024 Patrick M\u00fcller 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. ",
"summary": "Physics toolbox for laser spectroscopy",
"version": "0.3.6",
"project_urls": {
"documentation": "https://patmlr.github.io/qspec/doc/doc.html",
"download": "https://pypi.org/project/qspec/#files",
"homepage": "https://patmlr.github.io/qspec/",
"source": "https://github.com/patmlr/qspec",
"tracker": "https://github.com/patmlr/qspec/issues"
},
"split_keywords": [
"physics",
" laser spectroscopy",
" simulation",
" quantum mechanics",
" data analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93b91eeeb0f95e976eedfb51fe99a5f5df25c1571a8343ec8baacf62a0010e63",
"md5": "ec8b6f2d4bcc4a39b5f8b7fb6a7b8eac",
"sha256": "f8f28e55f775193c116369e22ac4980ac0eaa5d62c8ac424a244d5187402381c"
},
"downloads": -1,
"filename": "qspec-0.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec8b6f2d4bcc4a39b5f8b7fb6a7b8eac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 449433,
"upload_time": "2024-12-17T02:07:18",
"upload_time_iso_8601": "2024-12-17T02:07:18.068310Z",
"url": "https://files.pythonhosted.org/packages/93/b9/1eeeb0f95e976eedfb51fe99a5f5df25c1571a8343ec8baacf62a0010e63/qspec-0.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a1a55d59d2a219d18b80b0a39b61f7ebb71482b62b86f87a0e7dbcb0f1e5d595",
"md5": "d85548bb4fbe131ff877ef529ed82261",
"sha256": "e6cf75b975718ddf7bc38a6ac91fcc721facca255af230d9ec7d0bc6cb40075f"
},
"downloads": -1,
"filename": "qspec-0.3.6.tar.gz",
"has_sig": false,
"md5_digest": "d85548bb4fbe131ff877ef529ed82261",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 443048,
"upload_time": "2024-12-17T02:07:21",
"upload_time_iso_8601": "2024-12-17T02:07:21.097274Z",
"url": "https://files.pythonhosted.org/packages/a1/a5/5d59d2a219d18b80b0a39b61f7ebb71482b62b86f87a0e7dbcb0f1e5d595/qspec-0.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 02:07:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "patmlr",
"github_project": "qspec",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "matplotlib",
"specs": []
},
{
"name": "numpy",
"specs": [
[
">=",
"2.0.2"
]
]
},
{
"name": "scipy",
"specs": [
[
">=",
"1.13.1"
]
]
},
{
"name": "sympy",
"specs": []
}
],
"lcname": "qspec"
}
