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.0rc2.tar.gz (278.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file aisim-1.0.0rc2.tar.gz.

File metadata

  • Download URL: aisim-1.0.0rc2.tar.gz
  • Upload date:
  • Size: 278.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for aisim-1.0.0rc2.tar.gz
Algorithm Hash digest
SHA256 4ef01bc56dd593251a78365533510eda526896b21dcb191d9400dc5a761650c5
MD5 2596d3a50c9322008b961ed5455e3783
BLAKE2b-256 f74be71d67db12f6ec86bb647d04e9790fdf8e856ac9a1ac0df2bf085fac7bc7

See more details on using hashes here.

File details

Details for the file aisim-1.0.0rc2-py3-none-any.whl.

File metadata

  • Download URL: aisim-1.0.0rc2-py3-none-any.whl
  • Upload date:
  • Size: 39.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for aisim-1.0.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 0c256b1803ecf1ef772307bc67d8870ca9a180d31615a608010cc7272568ed9c
MD5 c357f54f0e44ac2257c9141e361f5d52
BLAKE2b-256 837505429bc440ec798f0f4c852fd50106330c03e9bf17cfb2ef9583312344c0

See more details on using hashes here.

Supported by

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