Skip to main content

Simulations for light-pulse atom interferometry

Project description

PyPI Conda Test Status Test Coverage Documentation Status Code style: black

AISim ‒ Simulations for light-pulse atom interferometry

AISim is a Python package for simulating light-pulse atom interferometers.

It uses dedicated objects to model the laser beams, the atomic ensemble and the detection system and store experimental parameters in a neat way. After you define these objects you can use built-in propagators to simulate internal and external degrees of freedom of cold atoms.

Installation

The latest tagged release can installed via pip with

pip install aisim

or via conda with

conda install -c conda-forge aisim 

Alternatively, if you plan to make changes to the code, use

git clone https://github.com/bleykauf/aisim.git
cd aisim
python setup.py develop

Usage

For basic usage and code reference, see the documentation.

Examples

Some examples are provided in the form of Jupyter notebooks:

Contributing

Contributions are very welcome. If you want to help, check out our contributions guide.

Authors

License

AISim ‒ Simulations for light-pulse atom interferometry

Copyright © 2023 B. Leykauf, S. Vowe

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aisim-1.0.0.tar.gz (278.7 kB view hashes)

Uploaded Source

Built Distribution

aisim-1.0.0-py3-none-any.whl (39.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page