Metadata-Version: 2.1
Name: aisim
Version: 0.7.2
Summary: Simulations for light-pulse atom interferometry
Home-page: https://github.com/bleykauf/aisim
Author: Bastian Leykauf
Author-email: leykauf@physik.hu-berlin.de
Maintainer: Bastian Leykauf
Maintainer-email: leykauf@physik.hu-berlin.de
License: UNKNOWN
Description: ![PyPI](https://img.shields.io/pypi/v/aisim?color=blue)
        ![Conda](https://img.shields.io/conda/v/conda-forge/aisim?color=blue&label=conda-forge)[![Build Status](https://travis-ci.com/bleykauf/aisim.svg?branch=master)](https://travis-ci.com/bleykauf/aisim)
        [![Documentation Status](https://readthedocs.org/projects/aisim/badge/?version=latest)](https://aisim.readthedocs.io/en/latest/?badge=latest)
        [![Coverage Status](https://coveralls.io/repos/github/bleykauf/aisim/badge.svg?branch=master)](https://coveralls.io/github/bleykauf/aisim?branch=master)
        
        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](https://aisim.readthedocs.io).
        
        Examples
        --------
        
        Some examples are provided in the form of [Jupyter
        notebooks](https://jupyter.org/):
        
        -   [Effect of wavefront aberrations in atom
            interferometry](https://github.com/bleykauf/aisim/blob/master/docs/examples/wavefront-aberrations.ipynb)
        -   [Rabi oscillations with a Gaussian beam and thermal
            atoms](https://github.com/bleykauf/aisim/blob/master/docs/examples/rabi-oscillations.ipynb)
        -   [Multiport atom interferometer](https://github.com/bleykauf/aisim/blob/master/docs/examples/multiport-ai.ipynb)
        
        Contributing
        ------------
        
        Contributions are very welcome. If you want to help, check out [our contributions guide](https://github.com/bleykauf/aisim/blob/master/docs/CONTRIBUTING.rst).
        
        Authors
        -------
        
        -   Bastian Leykauf (<https://github.com/bleykauf>)
        -   Sascha Vowe (<https://github.com/savowe>)
        
        License
        -------
        
        AISim ‒ Simulations for light-pulse atom interferometry
        
        Copyright © 2020 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/>.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.4
Description-Content-Type: text/markdown; charset=UTF-8
